From e05592f8d81e99acc10114a53685a37691fe1f10 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 19 Jun 2023 17:57:38 +0000 Subject: [PATCH 1/5] [pre-commit.ci] pre-commit autoupdate MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit updates: - [github.com/codespell-project/codespell: v2.2.4 → v2.2.5](https://github.com/codespell-project/codespell/compare/v2.2.4...v2.2.5) --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 7c24845438bd996d4b047e196ead5c94935cadcb Mon Sep 17 00:00:00 2001 From: Anish Dixit Date: Wed, 28 Jun 2023 14:25:23 -0700 Subject: [PATCH 2/5] Add dev env setup files --- dev_setup.sh | 15 +++++++++++++++ verify_setup.py | 3 +++ 2 files changed, 18 insertions(+) create mode 100644 dev_setup.sh create mode 100644 verify_setup.py diff --git a/dev_setup.sh b/dev_setup.sh new file mode 100644 index 0000000..0e2d999 --- /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 +conda develop ooipy +python ooipy/setup.py +python ooipy/verify_setup.py diff --git a/verify_setup.py b/verify_setup.py new file mode 100644 index 0000000..7f8e34c --- /dev/null +++ b/verify_setup.py @@ -0,0 +1,3 @@ +import ooipy +print("PATH TO OOIPY INSTALLATION") +print(ooipy.__file__) From 347db71d8853fbc7a74d6770dccc2db76a2159e6 Mon Sep 17 00:00:00 2001 From: Anish Dixit Date: Wed, 28 Jun 2023 14:27:21 -0700 Subject: [PATCH 3/5] Added instructions in docs --- docs/source/install_instructions.rst | 38 ++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/source/install_instructions.rst b/docs/source/install_instructions.rst index 8901aab..4675042 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. From a30b716cbcdcb78e295921169b9751c5950a0f8b Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 28 Jun 2023 21:31:59 +0000 Subject: [PATCH 4/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/install_instructions.rst | 18 +++++++++--------- verify_setup.py | 1 + 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/source/install_instructions.rst b/docs/source/install_instructions.rst index 4675042..2602fdd 100644 --- a/docs/source/install_instructions.rst +++ b/docs/source/install_instructions.rst @@ -30,30 +30,30 @@ How to setup OOIPY development environment git clone https://github.com/Ocean-Data-Lab/ooipy.git -2. Setup a new Conda environment using this command: +2. Setup a new Conda environment using this command: .. code-block :: bash conda create --name env_name -3. Activate the environment using this command: +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: +4. Run the script to setup the development environment and install dependencies using this command: .. code-block :: bash - - bash ooipy/dev_setup.sh - + + 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: +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 index 7f8e34c..f811c1c 100644 --- a/verify_setup.py +++ b/verify_setup.py @@ -1,3 +1,4 @@ import ooipy + print("PATH TO OOIPY INSTALLATION") print(ooipy.__file__) From c9008db5e80406d1d153db8bcb6f6d940c820e48 Mon Sep 17 00:00:00 2001 From: anishdixit-uw <122193072+anishdixit-uw@users.noreply.github.com> Date: Fri, 7 Jul 2023 11:40:15 -0700 Subject: [PATCH 5/5] Update dev_setup.sh with changed order of setup.py run --- dev_setup.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev_setup.sh b/dev_setup.sh index 0e2d999..32cc016 100644 --- a/dev_setup.sh +++ b/dev_setup.sh @@ -10,6 +10,6 @@ conda install -c conda-forge isort conda install numpydoc conda install -c conda-forge pre_commit conda install -c conda-forge pylint -conda develop ooipy python ooipy/setup.py +conda develop ooipy python ooipy/verify_setup.py