Skip to content

RELEASE_CONTENTS.md

Latest commit

 

History

History
40 lines (32 loc) · 1.69 KB

RELEASE_CONTENTS.md

File metadata and controls

40 lines (32 loc) · 1.69 KB
Raw

Release Contents

This file defines what belongs in public source releases and Python package artifacts. It is intentionally narrower than the full working tree used during research runs.

Include

  • Source code in illiad/ and standalone viewers in fastplotlib_tests/.
  • Command implementations under illiad/cli/ and direct-execution launchers: runFieldsolver.py, runPoincare.py, runFluxCalc.py, runFluxGrad.py, and runBoris.py.
  • Example configuration files: fieldsolver_inputs.json, poincare_inputs.json, flux_calc_inputs.json, flux_grad_inputs.json, boris_inputs.json, and animation_inputs.json.
  • Project metadata: pyproject.toml, README.md, LICENSE, and MANIFEST.in.
  • Small reference input files under input_files/, such as CSV geometry files, profile tables, and coils.wega_with_VFCoils.

Exclude

  • Generated analysis products under output/.
  • Python caches, test caches, virtual environments, editor state, local installers, and cluster job files.
  • Large generated scientific arrays such as .npy, .npz, .h5, and .hdf5 field/profile files under input_files/.
  • Manuscript drafts and large diagnostic measurement folders under input_files/.
  • Legacy and development scripts under misc_scripts/.

Data Policy

The source release should be installable and inspectable without bundled large simulation data. Public examples may refer to generated field files, but large arrays should be distributed separately through a DOI-backed archive, Git LFS, or a documented data-download step.

Small reference files that are required to understand geometry, ports, coil definitions, or default profiles may stay in git and in source distributions.