Merge pull request #190 from icesat2py/development

release v0.3.4 - post-conda fixes and updates

Author: JessicaS11

.github/workflows/traffic_action.yml

@@ -4,6 +4,8 @@ on:
   schedule: 
     # runs once a week on sunday
     - cron: "55 23 * * 0"
+  # Trigger manually at https://github.com/icesat2py/icepyx/actions/workflows/publish_to_pypi.yml
+  workflow_dispatch:
 
 jobs:
   # This workflow contains a single job called "traffic"
@@ -14,22 +16,28 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    # DevGoal: figure out how to put the traffic data directly into doc/source/tracking
     - uses: actions/checkout@v2
       with:
         ref: "traffic"
 
     # Calculates traffic and clones and stores in CSV file
     - name: GitHub traffic 
-      uses: sangonzal/repository-traffic-action@v0.1.2
+      uses: sangonzal/repository-traffic-action@v0.1.4
       env:
         TRAFFIC_ACTION_TOKEN: ${{ secrets.TRAFFIC_ACTION_TOKEN }} 
-     
+    
+    # Custom steps to move files to another dir and format plot
+    - name: Move files
+      run: |
+        pip install -r requirements.txt
+        python ./doc/source/tracking/traffic/traffic_data_mgmt.py
+    
     # Commits files to repository
     - name: Commit changes
       uses: EndBug/add-and-commit@v4
       with:
         author_name: Jessica Scheick
-        message: "GitHub traffic"
-        add: "./traffic/*"
-        ref: "traffic"  # commits to branch "traffic"
+        message: "GitHub traffic auto-update"
+        add: "./doc/source/tracking/traffic/*"
+#         add: "./traffic/*"
+        ref: "traffic"  # commits to branch "traffic"

README.rst

@@ -33,40 +33,19 @@ This project combines and generalizes these scripts into a unified framework, ma
 
 Installation
 ------------
-The simplest way to install icepyx is using pip.
 
-.. code-block::
+The simplest way to install icepyx is by using the
+`conda <https://docs.conda.io/projects/conda/en/latest/user-guide/index.html>`__
+package manager.
 
-  pip install icepyx
+    conda install icepyx
 
+Alternatively, you can also install icepyx using `pip <https://pip.pypa.io/en/stable/>`__.
 
-Windows users will need to first install `Fiona`_, please look at the instructions there. Windows users may consider installing Fiona using pipwin
+    pip install icepyx
 
-.. code-block::
-
-  pip install pipwin
-  pipwin install Fiona 
-
-
-Currently, updated packages are not automatically generated with each build. This means it is possible that pip will not install the latest release of icepyx. In this case, icepyx is also available for use via the GitHub repository. The contents of the repository can be download as a `zipped file`_ or cloned.
-
-To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system. 
-To clone the repository:
-
-.. code-block::
-
-  git clone https://github.com/icesat2py/icepyx.git
-
-
-Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add import icepyx to your Python document.
-Alternatively, in a command line or terminal, navigate to the folder in your cloned repository containing setup.py and run
-
-.. code-block::
-
-  pip install -e .
-
-
-Future developments of icepyx may include conda as another simplified installation option.
+More detailed instructions for installing `icepyx` can be found at
+https://icepyx.readthedocs.io/en/latest/getting_started/install.html
 
 
 Examples (Jupyter Notebooks)

doc/source/getting_started/install.rst

@@ -10,37 +10,71 @@
 Installation
 ============
 
-The simplest way to install icepyx is using pip.
+Quickstart
+----------
+
+The simplest way to install icepyx is by using the
+`conda <https://docs.conda.io/projects/conda/en/latest/user-guide/index.html>`__
+package manager. The command below takes care of setting up a virtual
+environment and installs icepyx along with all the necessary dependencies::
+
+    conda create --name icepyx-env --channel conda-forge icepyx
+
+To activate the virtual environment, you can do::
+
+    conda activate icepyx-env
+
+
+Using conda
+-----------
+
+If you already have a virtual conda environment set up and activated, you can
+install the latest stable release of icepyx from
+`conda-forge <https://anaconda.org/conda-forge/icepyx>`__ like so::
+
+    conda install icepyx
+
+To upgrade an installed version of icepyx to the latest stable release, do::
+
+    conda update icepyx
+
+
+
+Using pip
+---------
+
+Alternatively, you can also install icepyx using `pip <https://pip.pypa.io/en/stable/>`__.
 
 .. code-block::
 
   pip install icepyx
 
 
-Windows users will need to first install `Fiona`_, please look at the instructions there. Windows users may consider installing Fiona using pipwin
+Windows users will need to first install `Fiona`_, please look at the instructions there.
+Windows users may consider installing Fiona using pipwin
 
 .. code-block::
 
   pip install pipwin
-  pipwin install Fiona 
+  pipwin install Fiona
 
 
-Currently, updated packages are not automatically generated with each build. This means it is possible that pip will not install the latest release of icepyx. In this case, icepyx is also available for use via the GitHub repository. The contents of the repository can be download as a `zipped file`_ or cloned.
+Currently, conda and pip packages are generated with each tagged release.
+This means it is possible that these methods will not install the latest merged features of icepyx.
+In this case, icepyx is also available for use via the GitHub repository.
+The contents of the repository can be downloaded as a `zipped file`_ or cloned.
 
-To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system. 
+To use icepyx this way, fork this repo to your own account, then git clone the repo onto your system.
 To clone the repository:
 
 .. code-block::
 
   git clone https://github.com/icesat2py/icepyx.git
 
 
-Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add import icepyx to your Python document.
+Provided the location of the repo is part of your $PYTHONPATH, you should simply be able to add `import icepyx` to your Python document.
 Alternatively, in a command line or terminal, navigate to the folder in your cloned repository containing setup.py and run
 
 .. code-block::
 
-  pip install -e
-
-
-Future developments of icepyx may include conda as another simplified installation option.
+  pip install -e.