Add COC, add more links to docs and IO section (#46)

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ repos:
       - id: docformatter
         args: ["--in-place", "--pre-summary-newline", "--make-summary-multi"]
   - repo: https://github.com/myint/autoflake
-    rev: v2.2.1
+    rev: v2.3.1
     hooks:
       - id: autoflake
         args:
@@ -16,13 +16,13 @@ repos:
           ]
         exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|docs/conf.py)$"
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.2.1"
+    rev: "v0.4.2"
     hooks:
       - id: ruff
         args: ["--fix", "--unsafe-fixes"]
       - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-ast
       - id: check-case-conflict

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Code of Conduct
+
+The Solar Physics community is made up of members from around the globe with a diverse set of skills, personalities, and experiences.
+It is through these differences that our community experiences success and continued growth.
+We expect everyone in our community to follow these guidelines when interacting with others both inside and outside of our community.
+Our goal is to keep ours a positive, inclusive, successful, and growing community.
+
+## Open
+
+Members of the community are open to collaboration, whether on patches, reporting issues, asking for help or otherwise.
+We welcome those interested in joining the community, and realise that including people with a variety of opinions and backgrounds will only serve to enrich our community.
+
+We are accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference, ensuring that all participants are heard and feel confident that they can freely express their opinions.
+
+## Considerate
+
+Members of the community are considerate of their peers -- other developers, users, etc.
+We are thoughtful when addressing the efforts of others, keeping in mind that often the labour was completed simply for the good of the community.
+We are attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
+
+We recognize the work made by everyone and ensure the proper acknowledgement/citation of original authors at all times.
+As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.
+
+## Respectful
+
+Members of the community are respectful.
+We are respectful of others, their positions, their skills, their commitments, and their efforts.
+We are respectful of the volunteer and professional efforts within the community.
+We are respectful of the processes set forth in the community, and we work within them (paying particular attention to those new to the community).
+
+When we disagree, we are courteous in raising our issues.
+We provide a harassment- and bullying-free environment, regardless of sex, sexual orientation, gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion.
+In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
+We will treat those outside our community with the same respect as people within our community.
+
+Overall, we are good to each other and apply this code of conduct to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
+
+We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct.
+
+Parts of this code of conduct have been adapted from the [astropy](https://www.astropy.org/code_of_conduct.html) and the [Python Software Foundation](https://www.python.org/psf/conduct/) codes of conduct.
+
+---
+
+## License
+
+This Code of Conduct is licensed under a Creative Commons Attribution 4.0 International License.

docs/conf.py

@@ -110,12 +110,14 @@
         "https://docs.sunpy.org/projects/sunkit-instruments/en/stable/",
         None,
     ),
-    "zeep": ("https://docs.python-zeep.org/en/stable/", None),
     "asdf": ("https://asdf.readthedocs.io/en/stable/", None),
     "sunpy": ("https://docs.sunpy.org/en/stable/", None),
+    "sunraster": ("https://docs.sunpy.org/projects/sunraster/en/stable/", None),
+    "zeep": ("https://docs.python-zeep.org/en/stable/", None),
 }
 
 # -- Options for HTML output -------------------------------------------------
+html_theme = "sunpy"
 graphviz_output_format = "svg"
 sphinx_gallery_conf = {
     "backreferences_dir": Path("generated") / "modules",

docs/known_issues.rst

@@ -28,8 +28,7 @@ This means that one gets the correct answer only if one does the matrix multipli
 
 We work around this by modifying the PC_ij matrix to have the correct skew.
 Since the X CDELT is 1e-10 arcsec, the inverse is thankfully not infinity.
-Using equation 187 in `Calabretta & Greisen 2002
-<https://www.aanda.org/articles/aa/abs/2002/45/aah3860/aah3860.html>__`, we correct for this.
+Using equation 187 in `Calabretta & Greisen 2002 <https://www.aanda.org/articles/aa/abs/2002/45/aah3860/aah3860.html>__`, we correct for this.
 
 Note that since these pixels are extremely rectangular, an aspect ratio of ~3e-10, the cross terms in the
 PCij matrix are quite small: -3.4e-12 and -3.8e7.

docs/reference/index.rst

@@ -10,4 +10,5 @@ API Reference
    irispy
    sji
    spectrograph
+   io
    utils

docs/reference/io.rst

@@ -0,0 +1,7 @@
+****************
+IO (`irispy.io`)
+****************
+
+The `irispy.io` module provides tools to read level 2 files.
+
+.. automodapi:: irispy.io

docs/reference/sji.rst

@@ -5,3 +5,4 @@ SJI (`irispy.sji`)
 The `irispy.sji` module provides tools to read and work with level 2 SJI data.
 
 .. automodapi:: irispy.sji
+    :inherited-members:

docs/reference/spectrograph.rst

@@ -5,3 +5,4 @@ Spectrograph (`irispy.spectrograph`)
 The `irispy.spectrograph` module provides tools to read and work with level 2 spectrograph data.
 
 .. automodapi:: irispy.spectrograph
+    :inherited-members:

examples/README.txt

@@ -1,5 +1,5 @@
-*********
-Tutorials
-*********
+********
+Examples
+********
 
-This gallery contains tutorials of how to use ``irispy-lmsal``.
+This gallery contains examples of how to use ``irispy-lmsal``.

examples/align_iris_aia_rolled.py

@@ -196,7 +196,7 @@
 # and for this we need to rotate one of them. We can either rotate SDO/AIA to the
 # IRIS frame, or vice-versa.
 #
-# We will rotate the AIA data, using `.reproject_to`.
+# We will rotate the AIA data, using `sunpy.map.Map.reproject_to`.
 # As `sunpy` does not support gWCS, we have to use the basic WCS.
 
 aia_rot = aia_sub.reproject_to(sji_cut.basic_wcs)

irispy/_dev/scm_version.py

@@ -9,6 +9,6 @@
 except ImportError as e:
     msg = "setuptools_scm not installed"
     raise ImportError(msg) from e
-except Exception as e:  # NOQA: BLE001
+except Exception as e:
     msg = f"setuptools_scm broken with {e}"
     raise ValueError(msg) from e