Skip to content

Commit

Permalink
Merge pull request #89 from sunpy/cruft/update
Browse files Browse the repository at this point in the history
Updates from the package template
  • Loading branch information
nabobalis authored Feb 10, 2025
2 parents e91eae1 + f60f04f commit 592da5f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .cruft.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"template": "https://github.com/sunpy/package-template",
"commit": "29db3569a215e43fa8c5114d3dbcb98b6a9caac0",
"commit": "4f11e366c6efc9dcb5658ca952ec4196e201212b",
"checkout": null,
"context": {
"cookiecutter": {
Expand Down Expand Up @@ -32,7 +32,7 @@
".github/workflows/sub_package_update.yml"
],
"_template": "https://github.com/sunpy/package-template",
"_commit": "29db3569a215e43fa8c5114d3dbcb98b6a9caac0"
"_commit": "4f11e366c6efc9dcb5658ca952ec4196e201212b"
}
},
"directory": null
Expand Down
21 changes: 14 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
``sunkit-magex``
----------------
================

``sunkit-magex`` is a Python software package that provides a set of tools for the modelling of magnetic field data.
It is a SunPy affiliated package and is built on top of ``sunpy`` and ``astropy``.

Currently it only supports the potential field source surface (PFSS) model, but we hope to expand it to include other models in the future.

Installation
============
------------

We recommended following the `installation guide <https://docs.sunpy.org/projects/sunkit-magex/en/latest/installing.html>`__ in the documentation.

Usage
=====
-----

If you are new to ``sunkit-magex``, the best place to start is the `example gallery <https://docs.sunpy.org/projects/sunkit-magex/en/latest/generated/gallery/index.html>`__.

Changes
=======
-------

See our `changelog <https://docs.sunpy.org/projects/sunkit-magex/en/latest/whatsnew/changelog.html>`__.

Getting Help
============
------------

For more information or to ask questions about ``sunkit-magex`` or any other SunPy Project package, please check out:

Expand All @@ -31,7 +31,7 @@ For more information or to ask questions about ``sunkit-magex`` or any other Sun
- `SunPy Community forum <https://community.openastronomy.org/c/sunpy/5>`__

Contributing
============
------------

The SunPy Project is a community-driven open-source project that welcomes any and all contributions.
Whether you are a developer, student, or user, you can help by contributing code, documentation, or community support.
Expand All @@ -44,12 +44,19 @@ Help is always welcome, so come and say hello by joining the `SunPy Chat`_ and l
.. _Good First Issues list: https://github.com/sunpy/sunpy/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Good+First+Issue%22

Code of Conduct
===============
---------------

When you are interacting with the SunPy Community you are asked to follow our `Code of Conduct <https://sunpy.org/coc>`__.

.. _SunPy Chat: https://app.element.io/#/room/#sunpy:openastronomy.org

Usage of Generative AI
----------------------

We expect authentic engagement in our community.
Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content.
If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state.

License
-------

Expand Down

0 comments on commit 592da5f

Please sign in to comment.