diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 26706d4..821dc4d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,7 +32,7 @@ repos: - id: flake8 - repo: https://github.com/codespell-project/codespell - rev: v2.2.4 + rev: v2.2.5 hooks: - id: codespell # Ignores `.ipynb` files, `_build` and `_static` folders diff --git a/dev_setup.sh b/dev_setup.sh new file mode 100644 index 0000000..32cc016 --- /dev/null +++ b/dev_setup.sh @@ -0,0 +1,15 @@ +conda install numpy +conda install pandas +conda install matplotlib +conda install -c conda-forge obspy +conda install -c conda-forge fsspec +conda install black +conda install -c conda-forge check-manifest +conda install flake8 +conda install -c conda-forge isort +conda install numpydoc +conda install -c conda-forge pre_commit +conda install -c conda-forge pylint +python ooipy/setup.py +conda develop ooipy +python ooipy/verify_setup.py diff --git a/docs/source/install_instructions.rst b/docs/source/install_instructions.rst index 8901aab..2602fdd 100644 --- a/docs/source/install_instructions.rst +++ b/docs/source/install_instructions.rst @@ -19,3 +19,41 @@ OOIPY is designed to run on Python 3.8.5. To install OOIPY, run the following co pip install ooipy Please see our Getting Started Guide for a tutorial on basic OOIPY usage. + + +How to setup OOIPY development environment +========================================== + +1. Navigate into the folder where you wish to setup ooipy and clone the repository using this command: + +.. code-block :: bash + + git clone https://github.com/Ocean-Data-Lab/ooipy.git + +2. Setup a new Conda environment using this command: + +.. code-block :: bash + + conda create --name env_name + +3. Activate the environment using this command: + +.. code-block :: bash + + source activate env_name + +4. Run the script to setup the development environment and install dependencies using this command: + +.. code-block :: bash + + bash ooipy/dev_setup.sh + +Conda will ask for permissions while installing each library, answer 'y' to each. + +5. When this runs successfully, run the python file to verify if installation is proper, using this command: + +.. code-block :: bash + + python ooipy/verify_setup.py + +If the path printed out matches your local installation path for the ooipy github repository, your development environment has been properly setup. diff --git a/verify_setup.py b/verify_setup.py new file mode 100644 index 0000000..f811c1c --- /dev/null +++ b/verify_setup.py @@ -0,0 +1,4 @@ +import ooipy + +print("PATH TO OOIPY INSTALLATION") +print(ooipy.__file__)