Create and Populate requirements.txt in the Project Root

[Polichinel]

Objective

Create a requirements.txt file in the project root directory that accurately reflects all the dependencies required by the project. This will involve identifying all necessary packages, specifying appropriate versions, and ensuring compatibility with the current Conda environment.

Requirements

Task Details:

• Create requirements.txt:

  • Initialize a new requirements.txt file in the root directory of the project.

• Identify Dependencies:

  • Identify all packages currently used in the project, including those required for development, testing, and production.
  • Specify the appropriate version numbers for each package, ensuring consistency with the versions in the current Conda environment.

• Version Consistency:

  • Ensure that all package versions specified in requirements.txt are compatible with one another and suitable for the project's needs.
  • If version ranges are used, make sure they are appropriate and allow for necessary updates without introducing incompatibilities.

User Experience:

• The requirements.txt file should be clear, well-organized, and easy to use.
• Each entry should follow the standard format: package_name==version_number.
• Optionally, add comments for any non-standard packages or version ranges explaining why they are used.
• Add a link the the install guide for viewers etc. (If you feel the viewer guide should be copied into our documentation to insure locality and maybe so we can edit it to fit our needs, feel free to do so)

Actionable Steps

• Create requirements.txt File:

  • Initialize the requirements.txt file in the root directory of the project.

• Identify and Add Dependencies:

  • List all required packages and their respective versions based on the current Conda environment.

• Ensure Version Consistency:

  • Verify that the versions specified in requirements.txt are consistent with those in the current Conda environment and adjust as necessary.

• Organize and Document:

  • Organize the entries in requirements.txt clearly and logically.
  • Optionally, add comments where needed to explain non-standard version ranges or specific package choices.

• Test Across Environments:

  • Ensure the requirements.txt file works correctly across different operating systems

Documentation:

• Update any relevant documentation

NOTE: at this point, this file is not expected to play a role in setting up a environment. For now it is simply meant to be a reference