diff --git a/README.md b/README.md index 9bead61..3fe03c5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,8 @@ # ppe_tools tools for creating and analyzing parameter perturbation experiments + +### To use our python environment: + +conda env create -f environment.yml + +Then you should hopefully have ppe-py available as an environment in JupyterHub \ No newline at end of file diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..071f3c4 --- /dev/null +++ b/environment.yml @@ -0,0 +1,32 @@ +name: ppe-py +channels: + - conda-forge + - defaults +dependencies: + - python=3.7 # Python version 3.7 + - bottleneck # C-optimized array functions for NumPy + - cartopy # Geographic plotting toolkit + - cftime + - dask # Parallel processing library + - geopandas + - future # Python 2/3 compatibility + - h5py # Wrapper for HDF5 + - ipython # IPython interpreter and tools + - jupyter # Jupyter federation architecture + - jupyterlab + - matplotlib # 2D plotting library + - ncar-jobqueue + - nc-time-axis + - netcdf4 # Wrapper for netcdf4 + - notebook # Notebook interface + - numpy # N-d array and numerics + - pandas # Labeled array library + - scipy # Common math/stats/science functions + - scikit-learn # Macine learning library + - seaborn # Statistical visualizations + - shapely + - six # Python 2/3 compatibility + - sparse + - tqdm # Nice progressbar for longer computations + - xarray # N-d labeled array library + - xesmf \ No newline at end of file