Initial Settings in the Code

[mpatrou]

Short description of the changes:

Initial Settings in the code

Long description of the changes:

The changes include:

• adding hyspecplanningtools as package name in every reference
• mantid logger is replaced with python logger
• environment is updated with some initial dependencies
• gitignore update
• github actions updates
• notebooks/ removed
• scripts added with initial prototype/script and readme on how to run it
• pre-commit updates to exclude scripts
• code coverage and pre-commit related configurations
• badges for github action and code coverage
• README updates on installation process

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Manual test for the reviewer

Create the environment
conda env create

Activate the environment
conda activate hyspecplanningtools_dev

Install the package
pip install -e .

Start
hyspecplanningtools

1. To run the the prototype script
   python ./scripts/show_polarization_plots.py

2. To run the existing test
   pytest

References

[PPT] Set-up Repository for polarization planning tool

[codecov-commenter]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️