Skip to content

Commit

Permalink
Readme (#1)
Browse files Browse the repository at this point in the history
Fixed figures links, added language to code blocks
  • Loading branch information
vesninam authored Aug 15, 2023
1 parent faab7ae commit ffd89ab
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,27 @@ Features

* Global data plot

.. |Global map with sparse data| image:: docs/img/global_sparse.png
.. image:: docs/img/global_sparse.png
:alt: Global map with sparse data
:width: 600

* Global map plot

.. |Global map on regular grid| image:: docs/img/global_regular.png
.. image:: docs/img/global_regular.png
:alt: Global map on regular grid
:width: 600

* Regional data plot

.. |Regional map with sparse data| image:: docs/img/regional_sparse.png
.. image:: docs/img/regional_sparse.png
:width: 600
:alt: Regional map with sparse data

* Distance-time plot (under development)

.. |Distance time plot| image:: docs/img/distance_time.png
.. image:: docs/img/distance_time.png
:width: 600
:alt: Distance time plot

* Round Earth projection (under development)
* Animation plots (under development)
Expand All @@ -38,16 +42,22 @@ Installation

Make virtual environment with conda (optional):

.. code-block:: bash
conda create -n simurg_plotter python=3.10
conda deactivate
conda activate simurg_plotter
Install `poetry`:

.. code-block:: bash
pip install poetry
Install project:

.. code-block:: bash
poetry install
Support
Expand Down

0 comments on commit ffd89ab

Please sign in to comment.