LXCat

LXCat is an open-access website for collecting, displaying, and downloading electron and ion scattering cross sections, swarm parameters, reaction rates, energy distribution functions, and other data required for modeling low temperature plasmas.

Installation

To get familiar with the code read the following documentation:

docs/code-contributor.md for technology choices.
app/README.md for web application and web service.
packages/database/README.md for spinning up the database and filling it.
packages/schema/README.md for JSON schemas, validators and Typescript types of LXCat documents.
packages/converter/README.md for conversion to the legacy LXCat format.

Documentation

Documentation for different users can be found at docs/.

Production deployment

Create a .env.production file. The contents presented in app/README.md can be used as a guideline.

The production containers can be built and started by running

docker-compose up --build

Subsequently, the following commands can be used to setup and fill the database.

docker compose run setup setup
# To seed the db with test data set use:
docker compose run setup seed seeds/test
# To seed the db with production data, temporarily supply the source path as a read-only volume bound to `/data`:
docker compose -v <production data path>:/data:ro setup load-css /data
# To give an already logged in user admin rights:
docker-compose run setup make-admin <email of user>

The web application will run at http://localhost:3000. The app should be reversed proxied by a web server to provide https.

How to cite

If you use LXCat in your project or in a scientific publication, we would appreciate if you cite our project.

@software{LXCatLatest,
  author       = {Boer, Daan and
                  Verhoeven, Stefan and
                  Ali, Suvayu and
                  Graef, Wouter and
                  van Dijk, Jan},  
  title        = {LXCat},
  month        = jun,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {latest},
  doi          = {10.5281/zenodo.8095107},
  url          = {https://doi.org/10.5281/zenodo.8095107}
}

License

The code in this project is released under GNU Affero General Public License v3.0 or later. Except for the schema (packages/schema) and converter (packages/converter) packages which are released under Apache 2.0.

Copyright

Members of the LXCat team wrote the LXCat code. The authors are listed in CITATION.cff.

LXCat-project / LXCat