Maintenance/fair software

[mcw92]

Description

This PR implements the FAIR software action which assesses the compliance of the ARTIST codebase with fair-software.eu. The action runs upon pushes to the main branch.

Type of change

• New feature (non-breaking change which adds functionality)

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• My changes generate no new warnings

Current status

Checking compliance with fair-software.eu...
url: https://github.com/ARTIST-Association/ARTIST
(1/5) repository
      ✓ has_open_repository
(2/5) license
      ✓ has_license
(3/5) registry
      × has_ascl_badge
      × has_bintray_badge
      × has_conda_badge
      × has_cran_badge
      × has_crates_badge
      × has_maven_badge
      × has_npm_badge
      × has_pypi_badge
      × has_rsd_badge
      × is_on_github_marketplace
(4/5) citation
      × has_citation_file
      × has_citationcff_file
      × has_codemeta_file
      × has_zenodo_badge
      × has_zenodo_metadata_file
(5/5) checklist
      × has_core_infrastructures_badge

Calculated compliance: ● ● ○ ○ ○

To improve the fairness of ARTIST, we should:

• Add a CITATION.cff file. This can easily be generated with https://citation-file-format.github.io/cff-initializer-javascript/#/
• Add a PyPI badge once ARTIST is on PyPI.
• Add a Zenodo badge / doi once ARTIST is on Zenodo.

[github-actions]

Name	Stmts	Miss	Cover	Missing
artist\__init__.py	5	0	100%
artist\field\__init__.py	13	0	100%
artist\field\actuator.py	17	3	82%	97, 113, 129
artist\field\actuator_array.py	24	2	92%	83-84
artist\field\actuator_ideal.py	9	1	89%	40
artist\field\actuator_linear.py	37	0	100%
artist\field\facets_nurbs.py	23	0	100%
artist\field\heliostat.py	145	3	98%	105-106, 248
artist\field\heliostat_field.py	18	0	100%
artist\field\kinematic.py	10	2	80%	68, 79
artist\field\kinematic_rigid_body.py	48	0	100%
artist\field\receiver.py	40	2	95%	134, 138
artist\field\receiver_field.py	17	0	100%
artist\field\surface.py	17	0	100%
artist\raytracing\__init__.py	3	0	100%
artist\raytracing\heliostat_tracing.py	104	1	99%	4
artist\raytracing\rays.py	6	0	100%
artist\raytracing\raytracing_utils.py	9	0	100%
artist\scenario.py	114	2	98%	191, 628
artist\scene\__init__.py	4	0	100%
artist\scene\light_source.py	13	2	85%	63, 94
artist\scene\light_source_array.py	27	2	93%	81-82
artist\scene\sun.py	37	1	97%	228
artist\util\__init__.py	24	8	67%	56-57, 62-67
artist\util\config_dictionary.py	160	0	100%
artist\util\nurbs.py	130	10	92%	145-146, 240, 244, 246-247, 308-309, 312-313
artist\util\utils.py	35	0	100%
TOTAL	1089	39	96%

[kalebphipps]

Looks good to me!

Once we have the citation.cff the I am more than happy to merge!

[Filos1992]

Added an updated citation.cff file :) can be closed, except we want to wait for pypi?

[mcw92]

@Filos1992 Thanks for adding a citation file. However, I just found that you added a CITATION.cff for PAINT to ARTIST. While we can certainly use this file in the PAINT repo, we need another one for ARTIST itself. Please fix that (as well as the typos in the uploaded file before migrating it to PAINT).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.41%. Comparing base (bb12934) to head (e4e1deb).
Report is 17 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage   96.41%   96.41%           
=======================================
  Files          27       27           
  Lines        1089     1089           
=======================================
  Hits         1050     1050           
  Misses         39       39           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mcw92]

@Filos1992 There were still things wrong in the CITATION.cff file... I fixed them myself now and assigned @kalebphipps for review.

[kalebphipps]

One typo for the affiliation should be changed but apart from that everything looks good - I am happy to approve the PR!