Skip to main content

NEPC

workflow status Documentation Status GitHub DOI

The goals of the nepc project are to provide tools to:

  1. parse, evaluate, and populate metadata for electron scattering cross sections;
  2. build a NEPC MySQL database of cross sections;
  3. curate, access, visualize, and use cross section data from a NEPC database; and
  4. support verification and validation of electron scattering cross section data.

The database schema and Python module are designed for anyone interested in plasma chemistry with a background in physics at the graduate level.

Documentation for the nepc project: https://nepc.readthedocs.io.

Organization

The project is organized in the following directories:

  • tests - unit and integration testing
  • tests/data - data directory for the nepc_test database--an example NEPC database containing fictitious electron scattering cross section data used in unit and integration testing
  • tests/data/eda - example exploratory data analysis (EDA) of a NEPC database that is possible with the nepc Python module
  • tests/data/curate - code used to curate fictitious cross section data in LXCat format and create various NEPC Models for the nepc_test database
  • docs - files used by Sphinx to generate the NEPC documentation
  • nepc - the Python code for the nepc package and building a NEPC database
  • nepc/mysql - the Python code for creating a NEPC database from data in NEPC_CS_HOME environment variable; also creates the nepc_test database from data in NEPC_HOME/tests/data (must have the NEPC_HOME environment variable set)

Getting Started

To install nepc with pip, run:

$ pip install nepc

Establish a connection to the database named nepc running on a production server (you must set an environment variable NEPC_PRODUCTION that points to the production server):

>>> cnx, cursor = nepc.connect()

If you've built the nepc_test database on your local machine (see instructions here), establish a connection to it:

>>> cnx, cursor = nepc.connect(local=True, test=True)

Access the pre-defined plasma chemistry model, fict_min2, in the nepc_test database:

>>> fict_min2 = nepc.Model(cursor, "fict_min2")

Print a summary of the fict_min2 model, including a stylized Pandas dataframe:

>>> fict_min2.summary()

Plot the cross sections in fict_min2.

>>> fict_min2.plot(ylog=True, xlog=True, width=8, height=4) 

Additional examples of EDA using nepc are in tests/data/eda. Examples of scripts for curating raw data for the nepc_test database, including parsing LXCat formatted data, are in tests/data/curate.

Built With

Pronunciation

NEPC rhymes with the loser of the Cola War. If NEPC were in the CMU Pronouncing Dictionary, its entry would be N EH P S IY ..

Approved for public release, distribution is unlimited.

Metadata

Release files for nepc 2023.9.22

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nepc 2023.9.22
File Size Uploaded Provenance Actions
nepc-2023.9.22.tar.gz 32.0 kB Without provenance Details for nepc-2023.9.22.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nepc 2023.9.22
File Interpreter ABI Platform Actions
nepc-2023.9.22-py3-none-any.whl Python 3 none any Details for nepc-2023.9.22-py3-none-any.whl

Total release size: 64.7 kB

Release files / nepc-2023.9.22.tar.gz

Download URL nepc-2023.9.22.tar.gz
Size 32.0 kB
Tags Source
SHA-256 checksum
How to use checksums
0843dadb49d78dbd7ebe4f950dce579559b3ac1fcc0a4efea254d98e0a1754b3
BLAKE2b-256 checksum
How to use checksums
a6a7971bc40da51124be80676c4277f1f050e5c576be844659f8d3ad13e1b1aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.9.1 Darwin/22.6.0

Release files / nepc-2023.9.22-py3-none-any.whl

Download URL nepc-2023.9.22-py3-none-any.whl
Size 32.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
794151dcf02718a5aa6555f1781405f27504d85ab2d72bf575533374a995c6c6
BLAKE2b-256 checksum
How to use checksums
fe750e127931608d9c777af3aadb8fe2c8fce53fc558ceac57670cf808495192
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.9.1 Darwin/22.6.0

Security for nepc 2023.9.22

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page