Skip to content

Commit

Permalink
adding from source install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
anissa111 committed Jul 16, 2021
1 parent da5c083 commit 0b7c42b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
38 changes: 38 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,41 @@ Xarray, Scikit-learn, etc. when creating an environment.
If you are interested in learning more about how Conda environments work, please visit
the [managing environments](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
page of the Conda documentation.


## Building GeoCAT-viz from source

Building GeoCAT-viz from source code is a fairly straightforward task, but
doing so should not be necessary for most users. If you are interested in
building GeoCAT-viz from source, you will need the following packages to be
installed.

### Required dependencies for building and testing GeoCAT-viz

- Python 3.6+
- [GeoCAT-datafiles](https://github.com/NCAR/geocat-datafiles) (For tests only)
- [netcdf4](https://unidata.github.io/netcdf4-python/) (For tests only)
- [numpy](https://numpy.org/doc/stable/)
- [xarray](http://xarray.pydata.org/en/stable/)
- [matplotlib](https://matplotlib.org/stable/)
- [cartopy](https://scitools.org.uk/cartopy/docs/latest/)


### How to create a Conda environment for building GeoCAT-viz

The GeoCAT-viz source code includes a conda environment definition file,
`conda_environment.yml` in the root directory that can be used to create a
development environment containing all of the packages required to build GeoCAT-viz.

conda env create -f conda_environment.yml
conda activate geocat-viz

### Installing GeoCAT-viz

Once the dependencies listed above are installed, you can install GeoCAT-viz
with running the following command from the root-directory:

pip install .

For compatibility purposes, we strongly recommend using Conda to
configure your build environment as described above.
1 change: 1 addition & 0 deletions conda_environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ dependencies:
- scikit-learn
- sphinx
- wrf-python
- pip
- pip:
- pre-commit

0 comments on commit 0b7c42b

Please sign in to comment.