Alpha Release

[jared321]

For the BAND v0.5 release, we hope to include a minimal beta version of the bfrescox and bfrescoxpro packages so that

• users can install either package to build/install a Frescox binary,
• use the Python interface to run any Frescox simulation for which they have a valid NML input file for,
• load the simulation results using their own code.

In addition, users will be able to

• run simulations using an official, verified elastic scattering template (based on the Frescox example input) included in the packages
• load the simulation results using their own code or using code in the package.

Optionally, we set the goal to also include an inelastic scattering template (based on the Frescox example input).

Tasks for @jared321

• Integrate a full test of the 48Ca template functionality, which can serve as a guide for the elastic and inelastic templates
• Integrate a test of the Configuration class including testing the NML files generated from all templates included in the packages
• Setup actions for both packages
• Setup seeds for example notebooks in Jupyterbook that can be hosted in the repo's GH pages
• Setup surmise docs for hosting on RTD
• Populate developer's guide content

Tasks for @beykyle

The following tasks are being completed in this PR: #19

• Generate tests for the elastic, inelastic, and user provided templates
• Add functionality to the Configuration class to handle the cases of the for the elastic and inelastic templates
• Merge parsing functionality into main

These tasks are being handled concurrently on an independent branch:

• write the user's guide portion of the sphinx documentation and the main text of the Jupyterbook
• Write main README.md

Tasks for @manuelcatacora

• Add parsing functionality

Unassigned tasks

• Determine official names for both packages in conjunction with Frescox developer
  • OK with Bfrescox and Bfrescoxpro although these could be changed after the alpha release since we will not be distributing these packages in PyPI as part of the alpha release
• Determine versioning scheme and select first version
  • Semantic starting with 0.0.1
• Determine and add in license
• Determine and finalize package metadata in the setup.py of both packages
• Issue Determine external dependence versions #25
• Issue Update API, docs, and notebook in feature-template branch #38
• Ensure that all mandatory BAND SDK requirements are achieved

[beykyle]

Closed in #19