Getting StartedΒΆ

Dependencies

To use Hypnos, the following are required:

This code should be run with Coreform Cubit 2024.3+. The DAGMC workflow will not work in previous versions. The cubit python library must be accessible by python. On linux:

export PYTHONPATH=$PYTHONPATH:/path-to-cubit/bin

Package Installation

Install Hypnos using pip (in hypnos/, the root directory):

pip install .

If using as a developer, install as an editable:

pip install --editable .

Tests

To run tests, use Pytest:

pip install pytest
pytest

After setting up Hypnos, consult the User Guide