Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarifying environment setup in README #13

Open
LevanBokeria opened this issue Jan 9, 2025 · 2 comments · May be fixed by #16
Open

Clarifying environment setup in README #13

LevanBokeria opened this issue Jan 9, 2025 · 2 comments · May be fixed by #16
Assignees
@LevanBokeria

Comments

@LevanBokeria
Copy link
Collaborator

Currently, the readme starts with the package installation instructions. I suggest adding an initial step of:

  1. Cloning the git repository.
  2. Creating a python virtual environment inside the folder: python -m venv myenv
  3. Then install the package with pip: pip install git+https://github.com/MaxBalmus/ModularCirc.git
@LevanBokeria LevanBokeria self-assigned this Jan 9, 2025
@LevanBokeria LevanBokeria changed the title Clarifying environment setups in README Clarifying environment setup in README Jan 9, 2025
@crangelsmith
Copy link
Collaborator

Add both venv and conda and integrate to a CI.

@LevanBokeria
Copy link
Collaborator Author

In toml file, Levan will remove package versions.

Then @MaxBalmus check if notebooks work.

  • tutorial 2. Check if scipy upgrade makes a difference in outputs.
  • Then make an issue specifying which numerical test would be good to automatise. Levan and Camila can add that later.

@LevanBokeria LevanBokeria linked a pull request Jan 24, 2025 that will close this issue
13 clarifying environment setup in readme #16
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@LevanBokeria LevanBokeria

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

13 clarifying environment setup in readme alan-turing-institute/ModularCirc
2 participants
@LevanBokeria @crangelsmith