Skip to content

Commit

Permalink
DOC: Update links and development section.
Browse files Browse the repository at this point in the history
  • Loading branch information
greglucas committed Jan 29, 2023
1 parent 0950109 commit 9190a62
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
27 changes: 25 additions & 2 deletions docs/source/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,33 @@
Development
===========

To contribute to pymsis, all you need to do is fork the GitHub repository,
To contribute to pymsis, you can fork the GitHub repository,
add your code, and make a pull request. If you are adding additional functionality,
you should also include a test with your enhancement.

Pymsis is purposefully minimal, with numpy as the only dependency.
Pymsis is purposefully minimal, with Numpy as the only dependency.
This makes it easy for other packages to leverage the interface to the Fortran
code without imposing a specific data storage or plotting framework.

A typical development workflow might look like the following:

.. code:: bash
# Install the development dependencies
pip install .[dev]
# Install the pre-commit hooks
pre-commit install
# Update the code on a feature branch
git checkout -b my-cool-feature
# Run the tests
pytest
# Commit the changes and push to your remote repository
git add my-file
git commit
git push -u origin my-cool-feature
# Go to GitHub and open a pull request!
5 changes: 3 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ Pymsis Documentation
====================

This is a lightweight Python wrapper around the MSIS00 and MSIS2 Fortran source code.
The `MSIS model <https://www.nrl.navy.mil/ssd/branches/7630/modeling-upper-atmosphere>`_ is
developed by the Naval Research Laboratory.
The `MSIS model <https://www.nrl.navy.mil/Our-Work/Areas-of-Research/Space-Science/>`_ is
developed by the Naval Research Laboratory. For quick access to the model data without any code,
there is a web viewer that uses pymsis: `<https://swx-trec.com/msis>`_.

The :ref:`examples` are a good reference for quickly getting started with the Python code and demonstrate
how to call the models and plot the results. The explicit interfaces are described in the :ref:`api`.
Expand Down

0 comments on commit 9190a62

Please sign in to comment.