cosimoNigro / agnpy

Modelling jetted Active Galactic Nuclei radiative processes with python
https://agnpy.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
48 stars 33 forks source link

Fixes in the docs before 0.2.0 release #126

Closed cosimoNigro closed 2 years ago

cosimoNigro commented 2 years ago

This PR implements minor fixes in the documentation before making the release 0.2.0.

Among them I clarified, both in the README and in the main doc page, how to cite agnpy.

After thinking about it, I think this is the best option for acknowledging, the CITATION.cff files looks more useful in case a proper release paper is absent, and one wants to cite the zenodo record. I specify in the docs and in the README page to cite both.

I also removed from the docs this page where all the calculations are derived, it was updated, and the same formulas can now be found in the agnpy release paper.

review-notebook-app[bot] commented 2 years ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

cosimoNigro commented 2 years ago

One last thing: the notebooks included in the docs can be automatically run by sphinx, so from now on we should submit them without the output cells, i.e. non-executed. This way it will be easier to review them and we can reduce the amount of lines we add each time.

The only exceptions are the fitting notebooks, as some of them take a while to run, I suggest we commit them as already executed, so including the output cells.

codecov[bot] commented 2 years ago

Codecov Report

Merging #126 (3896868) into master (3f9a2ef) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #126   +/-   ##
=======================================
  Coverage   97.33%   97.33%           
=======================================
  Files          38       38           
  Lines        3000     3000           
=======================================
  Hits         2920     2920           
  Misses         80       80           
Flag Coverage Δ
unittests 97.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more