Skip to content

Commit

Permalink
Update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
eduardo-rodrigues committed Jul 3, 2023
1 parent 3cba0e7 commit 9db36cf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ If you want a non-default data file distributed with the package just proceed as
.. code-block:: python
>>> from particle import data
>>> Particle.load_table(data.basepath / "particle2020.csv"))
>>> Particle.load_table(data.basepath / "particle2022.csv"))
>>> Particle.load_table(data.basepath / "nuclei2022.csv"), append=True) # I still want nuclei info
>>> Particle.table_names() # list the loaded tables
Expand Down
12 changes: 6 additions & 6 deletions src/particle/data/README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Particle Data folder contents
-----------------------------

You can ``import particle.data``, then use ``particle.data.basepath / "particle2022.csv"``
You can ``import particle.data``, then use ``particle.data.basepath / "particle2023.csv"``
to access data reliably regardless of how you have installed or are running the package (even from a zip file!).


Expand All @@ -20,7 +20,7 @@ An extension file for the extended PDG data file, prepared by this package's mai
It contains entries necessary to provide extended information for the particles in the standard .mcd file.


``mass_width_2022.mcd``
``mass_width_2023.mcd``
=======================

The latest version of the PDG particle data file, downloaded from the PDG website
Expand All @@ -29,7 +29,7 @@ with much less information, but with more particles and more up to date.
A few older years are included, too.


``particle2022.csv``
``particle2023.csv``
====================

The combined data file, in a format that is easy for the ``Particle`` class to read and easy for physicists to extend or edit.
Expand All @@ -38,20 +38,20 @@ If you'd like to append to this file, write a similar file with the same header,
.. code-block:: python
Particle.read_table()
Particle.read_table('...', append=True)
Particle.read_table("...", append=True)
to read in the original table and then the new file you've written.

This file was created from ``pdgid_to_latexname.csv``, ``mass_width_2008.fwf``,
``mass_width_2008_ext.fwf`` and ``mass_width_2022.mcd``.
``mass_width_2008_ext.fwf`` and ``mass_width_2023.mcd``.
The 2008 version of the file was created with only the first two.


``nuclei2022.csv``
==================

Information on nuclei extracted and adapted from package ``periodictable``,
available in the same format as that of ``particle2022.csv``.
available in the same format as that of ``particle2023.csv``.


``conversions.csv``
Expand Down

0 comments on commit 9db36cf

Please sign in to comment.