diff --git a/README.md b/README.md index d79b662..28c60c8 100644 --- a/README.md +++ b/README.md @@ -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 +conda activate +``` + # Which missions are supported? _DAXA is still in a relatively early stage of development, and as such the support for local re-processing is diff --git a/docs/source/install.rst b/docs/source/install.rst index 72be769..aa492b2 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -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 `_ 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 + conda activate + 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.