Skip to content

Conversation

@Grochocinski
Copy link
Collaborator

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 pip instructions to make the package more accessible and easier to set up. Additionally, this PR standardizes the pyproject.yaml as the single source of dependency truth for the project by removing the separate environment.yaml files for both the docs and the package.

Methodology

  • The ReadTheDocs config file was adjusted to install dependencies from the pyproject.yaml instead of the docs-specific Conda environment.yaml. The environment.yaml file for the docs was then deleted since it was no longer being used.
  • The project's top-level environment.yaml file was deleted since it was essentially a duplicate of the pyproject.yaml dependency list.
  • The two setup_simopt files were deleted as their original role was to streamline the process of creating the Conda environment, installing the Ruby dependency, and installing the valid version of the datafarming gem. Once the Ruby dependency 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.
  • The README was updated to use generalized installation instructions instead of having Conda-specific instructions that refer to the above scripts, along with some minor tweaking to improve the flow of the instructions.

Verification

  • ruff check passes on my code
  • ty check passes on my code
  • The bug is reproducible on the master branch.
  • The bug is NO LONGER reproducible on this branch.
  • All tests in the tests directory are passing.

@Grochocinski Grochocinski self-assigned this Nov 26, 2025
@Grochocinski Grochocinski added bug Something isn't working documentation Improvements or additions to documentation labels Nov 26, 2025
@Grochocinski Grochocinski force-pushed the fix_workflow_instructions branch from 77c2a52 to 5f316f2 Compare November 27, 2025 01:25
@Grochocinski
Copy link
Collaborator Author

rebased + force-pushed to include the bugfix for the ty check not passing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Revisit Need for Conda-only support and setup_simopt Scripts

2 participants