Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
danehkar committed Nov 2, 2022
1 parent 604ee86 commit 54e10da
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ pyEQUIB Python Package
:target: https://doi.org/10.21105/joss.02798
:alt: JOSS


.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/equib/pyEQUIB/HEAD?labpath=Notebooks.ipynb

Description
===========

Expand Down Expand Up @@ -93,6 +95,15 @@ How to Use

The Documentation of the Python functions provides in detail in the *API Documentation* (`equib.github.io/pyEQUIB/doc <https://equib.github.io/pyEQUIB/doc>`_). There are three main object units:


See *Jupyter Notebooks*: `Notebooks.ipynb <https://github.com/equib/pyEQUIB/blob/master/Notebooks.ipynb>`_

Run *Jupyter Notebooks* on `Binder <https://mybinder.org/v2/gh/equib/pyEQUIB/HEAD?labpath=Notebooks.ipynb>`_:

.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/equib/pyEQUIB/HEAD?labpath=Notebooks.ipynb


* **Collision Unit** has the API functions for plasma diagnostics and abundance analysis of collisionally excited lines. Here are some examples of using *Collision* Unit:

- *Temperature*::
Expand Down

0 comments on commit 54e10da

Please sign in to comment.