Skip to content

Commit

Permalink
updated docs a bit to reflect new version coming and update install d…
Browse files Browse the repository at this point in the history
…ocs (#36)
  • Loading branch information
AndrewAnnex committed Mar 22, 2023
1 parent c05d94b commit 962e5d1
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Andrew M. Annex'

# The full version, including alpha/beta/rc tags
release = '0.2.1'
release = '0.3.0'

# set latex engine for unicode
latex_engine = 'xelatex'
Expand Down
40 changes: 23 additions & 17 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,56 +4,62 @@ Installation

This guide assumes that the user has already installed anaconda with conda version newer than 4.9.

ASAP requires that Install both Ames Stereo Pipeline and ISIS are available to the user in the PATH, and the user will need to have downloaded the relevant ISIS data folders.
Below we provide a guide assuming the user has a working ISIS installation in some other conda environment, and a a local copy of the pre-compiled Ames Stereo Pipeline.
Please refer to the `Ames Stereo Pipeline Installation <https://stereopipeline.readthedocs.io/en/latest/installation.html#precompiled-binaries-linux-and-macos>`_ documentation for details on how to download the precompiled ASP.
ASAP requires that both Ames Stereo Pipeline and ISIS are available to the user in the PATH, and the user will need to have downloaded the relevant ISIS data folders.

We will create a new conda environment for ASAP that includes the bin directories in the PATH for ASAP and the ISIS data folder environment variables.
In the variables section, you will need to update the parameters for your environment.
To start it is necessary to:

1. Create a dedicated ISIS conda environment following the instructions at https://github.com/DOI-USGS/ISIS3
2. Download and extract the pre-compiled Ames Stereo Pipeline binary following the first step in `Ames Stereo Pipeline Installation <https://stereopipeline.readthedocs.io/en/latest/installation.html#precompiled-binaries-linux-and-macos>`_

Now we will make a 2nd conda environment dedicated for ASAP using the following conda yml file environment specfication (for background on this subject please read `the related conda documentation <https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file>`_).

In the variables section at the bottom, you will need to update the parameters for your environment.
The ISISROOT directory is the conda environment folder for your working ISIS installation, for example "~/anaconda/envs/isis/", it can also be found by activating the environment and printing the $CONDA_PREFIX variable.
The two ISIS data directories are explained in the `ISIS installation documentation <https://github.com/USGS-Astrogeology/ISIS3>`_.
The two ISIS data directories are explained in the `ISIS installation documentation <https://github.com/DOI-USGS/ISIS3>`_.
The ASPROOT directory similarly points to the unzipped archive of the Ames Stereo Pipeline.


.. code-block:: yaml
name: asap_0_2_0
name: asap_0_3_0
channels:
- conda-forge
- defaults
dependencies:
- python=3.8
- python>=3.11
- ale
- black=19.10b0
- pvl
- nb_conda_kernels
- jupyterlab
- requests
- fire
- tqdm
- sh
- papermill
- rasterio
- pyproj
- shapely
- pvl
- pip
- sh
- pip
- pip:
- moody>=0.0.4
- asap_stereo=0.2.0
- moody>=0.2.0
- asap_stereo=0.3.0
variables:
ISISROOT: /path/to/your/isis/conda/env/
ISISDATA: /path/to/your/isis/data/dir/
ISISTESTDATA: /path/to/optional/isis/test/data/dir/
ASPROOT: /path/to/your/precompiled/StereoToolkitDirectory/
Using the command::
Once the above yml file has been updated, create the environment using the command::

conda env create --file asap.yml

This will create a new conda environment called "asap_0_2_0". The environment however is not ready to use yet.
We need to update the path to ensure ASP and ISIS programs are available for ASAP to use.
This will create a new conda environment called "asap_0_3_0". The environment however is not ready to use yet.
We need to update the PATH for this conda environment to ensure ASP and ISIS programs are available for ASAP to use.
To do this run the following commands::

conda activate asap_0_2_0
conda activate asap_0_3_0
conda env config vars set PATH=$PATH:$ASPROOT/bin:$ISISROOT/bin
conda deactivate

Expand Down
2 changes: 1 addition & 1 deletion src/asap_stereo/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.2.1"
__version__ = "0.3.0"

0 comments on commit 962e5d1

Please sign in to comment.