Fix workflow instructions #208
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Linked Issue (Required)
Fixes #186
The Fix
Background
TLDR for issue 186: the project used to use Conda since it made installing our Ruby dependency easy, but now that the project doesn't use Ruby it doesn't need to railroad everyone into using Conda.
PR Goal
This PR aims to update the README and replace the old Conda install instructions with generalized
pipinstructions to make the package more accessible and easier to set up. Additionally, this PR standardizes thepyproject.yamlas the single source of dependency truth for the project by removing the separateenvironment.yamlfiles for both the docs and the package.Methodology
pyproject.yamlinstead of the docs-specific Condaenvironment.yaml. Theenvironment.yamlfile for the docs was then deleted since it was no longer being used.environment.yamlfile was deleted since it was essentially a duplicate of thepyproject.yamldependency list.setup_simoptfiles were deleted as their original role was to streamline the process of creating the Conda environment, installing theRubydependency, and installing the valid version of thedatafarminggem. Once theRubydependency was removed, the scripts only had a single Conda-centric job (creating/updating the conda environment). Since we no longer mandate the use of Conda, it doesn't make sense to keep these environment-creating scripts around.Verification
ruff checkpasses on my codety checkpasses on my codemasterbranch.testsdirectory are passing.