Skip to content

Commit 3365fc1

Browse files
DOCS: Update README formatting, include external links
1 parent 2c06c1f commit 3365fc1

1 file changed

Lines changed: 31 additions & 16 deletions

File tree

README.rst

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,39 @@
4444
<br/>
4545
</p>
4646

47+
<p align="center">
48+
<strong>Fast field line tracing for spherical vector fields</strong>
49+
</p>
4750

48-
Python extension for tracing field lines using the
49-
`MapFL <https://github.com/predsci/MapFL>`_ Fortran tracer.
51+
52+
**mapflpy** is a python package for tracing field lines using the
53+
`MapFL <https://github.com/predsci/MapFL>`_ Fortran tracer developed by
54+
Predictive Science Inc.
5055

5156
The goal of **mapflpy** is to provide fast and accurate tracing capabilities for
5257
spherical vector fields inside a convenient Python interface. **mapflpy** is
53-
designed to work natively with the staggered meshes produced by
54-
Predictive Science Inc.'s codes for simulating the solar corona, and
55-
inner heliosphere (*e.g.* `MAS <https://www.predsci.com/mas>`_ or
56-
`POT3D <https://github.com/predsci/POT3D>`_), but it should be generally compatible
57-
with any global vector field that can be described on a rectilinear grid in
58-
spherical coordinates.
59-
60-
Resources
61-
---------
62-
63-
- **Predictive Science Inc.:** https://predsci.com
64-
- **Source Code:** https://github.com/predsci/mapflpy
65-
- **Documentation:** https://predsci.com/doc/mapflpy
66-
- **Distribution:** https://pypi.org/project/mapflpy
58+
designed to work natively with the staggered meshes produced by Predictive Science
59+
Inc.'s codes for simulating the solar corona, and inner heliosphere (*e.g.*
60+
`MAS <https://www.predsci.com/mas>`_ or `POT3D <https://github.com/predsci/POT3D>`_),
61+
but it should be generally compatible with any global vector field that can be
62+
described on a rectilinear grid in spherical coordinates.
63+
64+
To get started with **mapflpy**, visit the
65+
`User Guide <https://predsci.com/doc/mapflpy/guide/>`_ for installation instructions,
66+
an overview of features, and development/contribution guidelines; a gallery of
67+
`examples <https://predsci.com/doc/mapflpy/gallery/>`_ is also available, showcasing
68+
various use cases and functionalities of the package. Please direct any questions or
69+
issues pertaining to **mapflpy** to the repository `issue tracker <https://github.com/predsci/mapflpy/issues>`_,
70+
or `contact <https://www.predsci.com/portal/contact.php>`_ Predictive Science Inc. directly.
71+
72+
----
73+
74+
.. raw:: html
75+
76+
<p align="center">
77+
<a href="https://predsci.com">Predictive Science Inc.</a> |
78+
<a href="https://github.com/predsci/mapflpy">Source Code</a> |
79+
<a href="https://predsci.com/doc/mapflpy">Documentation</a> |
80+
<a href="https://pypi.org/project/mapflpy">Distribution</a>
81+
</p>
6782

0 commit comments

Comments
 (0)