Skip to content

Commit

Permalink
Added mention of how to create the environment using conda lock files…
Browse files Browse the repository at this point in the history
… to the README and the install sections of the docs - indirectly for issue #268

Signed-off-by: David Turner <turne540@msu.edu>
  • Loading branch information
DavidT3 committed Aug 9, 2024
1 parent 7954d44 commit 3d37149
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ cd DAXA
python -m pip install --editable .
```

We also provide a Conda lock file in the conda_envs directory (see [conda-lock GitHub README](https://github.com/conda/conda-lock/blob/main/README.md) on how to install conda-lock), which can be used to create an Anaconda environment with the required dependencies:

```shell script
conda-lock install -n <YOUR ENVIRONMENT NAME GOES HERE>
conda activate <YOUR ENVIRONMENT NAME GOES HERE>
```

# Which missions are supported?

_DAXA is still in a relatively early stage of development, and as such the support for local re-processing is
Expand Down
6 changes: 6 additions & 0 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ Alternatively you could use the 'editable' option (this has replaced running set
cd DAXA
python -m pip install --editable .
We also provide a Conda lock file in the conda_envs directory (see `conda-lock GitHub README <https://github.com/conda/conda-lock/README.md>`_ on how to install conda-lock), which can be used to create an Anaconda environment with the required dependencies:

.. code-block::
conda-lock install -n <YOUR ENVIRONMENT NAME GOES HERE>
conda activate <YOUR ENVIRONMENT NAME GOES HERE>
Once installed, you can import DAXA in the usual way (the command will be lowercase, 'import daxa'). If you have stayed
in the DAXA directory cloned from GitHub and opened Python there then it is possible to 'import DAXA', but that will behave
very strangely as it hasn't actually imported the module, but the directory.
Expand Down

0 comments on commit 3d37149

Please sign in to comment.