Skip to content

Commit

Permalink
Landing image (#5)
Browse files Browse the repository at this point in the history
* Add readme badge

* Add landing image

* Rename Readme to rst

* Fix typo

* Fix badge link

* Add downloads badge

* Change back to md
  • Loading branch information
AlexHls authored Dec 1, 2023
1 parent b4c96d4 commit 3cf6663
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# hesmapy
# Hesmapy

![PyPI - Version](https://img.shields.io/pypi/v/hesmapy)
![PyPI - Downloads](https://img.shields.io/pypi/dm/hesmapy)

HESMA Python - Tools for reading HESMA models

## Documentation
Expand Down Expand Up @@ -45,3 +49,4 @@ See the documentation for more details.

### Tracer
*(Not yet implemented)*

Binary file added docs/source/_static/landing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@
Welcome to Hesmapy's documentation!
===================================

.. image:: _static/landing.png
:alt: Hesmapy Landing Image

.. image:: https://img.shields.io/pypi/v/hesmapy.svg
:target: https://pypi.python.org/pypi/hesmapy
:alt: PyPI version

.. image:: https://img.shields.io/pypi/dm/hesmapy
:target: https://pypi.python.org/pypi/hesmapy
:alt: PyPI - Downloads

Hesmapy is a Python package providing a set of tools to work with the data from the HESMA.
It introduces a new data sturcture for the HESMA data in an attempt to make the data more accessible and easier to work with.
For the more simple data, tools such as plotting are provided.
Expand Down

0 comments on commit 3cf6663

Please sign in to comment.