Skip to content

Commit

Permalink
clarified installation guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
dodu94 committed Mar 5, 2024
1 parent 2b1a9b8 commit 0dcfb98
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/source/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ you can clone the repository:
| ``mv JADE Code``
| ``cd Code``
The folder strucure should now look like the following:
::
<JADE_root>
| --------- Code
| ------ jade
| ------ setup.cfg
| ------ pyproject.toml
| ------ ...


The user can then checkout the relevant branch of the code. It is now recommended that you upgrade pip before performing
the installation:

Expand Down Expand Up @@ -75,6 +85,12 @@ cmdlet in order to be able to activate the virtual environment.
Once activated, the steps described above for Linux can be followed.

If you use conda for managing your python environments, you can create a new environment and install JADE as follows:

| ``conda create -n jade_env python=3.X`` where 3.X is the version of python you want to use
| ``conda activate jade_env``
| ``pip install .``
Currently, only the running of MCNP is supported on Windows and JADE should be configured accordingly.
This is further detailed in :ref:`mainconfig`.

0 comments on commit 0dcfb98

Please sign in to comment.