Skip to content

Commit 0928f3f

Browse files
author
OpenMC Wrapper Contributors
committed
docs: update README with accurate OpenMC installation instructions
- Remove incorrect 'pip install openmc' reference - Add OpenMC build-from-source instructions - Add nuclear data setup requirements - Update PromptMC installation to use venv instead of Poetry - Update GitHub URL to correct repository
1 parent 6679ce6 commit 0928f3f

1 file changed

Lines changed: 40 additions & 8 deletions

File tree

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,53 @@ Whether you're new to Monte Carlo or an experienced researcher, PromptMC reduces
6262
### Prerequisites
6363

6464
- Python 3.9 or higher
65-
- Poetry (for development)
66-
- OpenMC (Python API via `pip install openmc` or executable in PATH)
65+
- OpenMC (built from source or executable in PATH)
66+
- Nuclear cross-section data (for running simulations)
6767

68-
### Install from Source
68+
### Install OpenMC
69+
70+
OpenMC is not available via pip. Build from source:
71+
72+
```bash
73+
# Install build dependencies (macOS with Homebrew)
74+
brew install cmake hdf5
75+
76+
# Clone and build OpenMC
77+
git clone https://github.com/openmc-dev/openmc.git
78+
cd openmc
79+
mkdir build && cd build
80+
cmake ..
81+
make -j4
82+
sudo make install
83+
```
84+
85+
For detailed installation instructions, see https://docs.openmc.org/en/stable/quickstart.html
86+
87+
### Install Nuclear Data
88+
89+
OpenMC requires nuclear cross-section data to run simulations:
90+
91+
1. Register at https://www.nndc.bnl.gov/ for data access
92+
2. Download ENDF/B-VII.1 or similar cross-section library (~2-3 GB)
93+
3. Create a `cross_sections.xml` file pointing to the data
94+
4. Set `OPENMC_CROSS_SECTIONS` environment variable
95+
96+
### Install PromptMC
6997

7098
```bash
7199
# Clone the repository
72-
git clone https://github.com/your-org/promptmc.git
100+
git clone https://github.com/rjonace/promptmc.git
73101
cd promptmc
74102

75-
# Install with Poetry
76-
poetry install
103+
# Create virtual environment
104+
python3 -m venv .venv
105+
source .venv/bin/activate
106+
107+
# Install in editable mode
108+
pip install -e .
77109

78-
# Activate the virtual environment
79-
poetry shell
110+
# Install development dependencies (optional)
111+
pip install pytest pytest-cov mypy ruff pre-commit bandit
80112
```
81113

82114
### Install as a Package (when published)

0 commit comments

Comments
 (0)