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

Recommend https install #297

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Recommend https install #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a71ec23
Recommend https install
ggggggggg Jul 25, 2024
05f1381
Keep old instructions for ssh-based install, too
joefowler Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,16 @@ Mass requires Python version 3.8 or higher. (We test it automatically with versi
### 1. Virtual environment (recommended approach)

Virtual environments are easy to set up. They let you keep up with separate dependencies for separate projects. However, you might want a more inclusive name, particularly on a data acquisition server. The venv you make should probably include MASS and other DAQ software. We used to use `qsp` (="quantum sensors project", though it's now a NIST division, not a project). The following assumes that you want your virtual environment to be named `analysis`
```
```bash
python3 -m venv ~/analysis
source ~/analysis/bin/activate
pip install --upgrade pip
pip install -e git+https://github.com/usnistgov/mass.git#egg=mass
```


The above (HTTPS) cloning method is probably simpler initially (no ssh setup), but users who contribute to MASS might prefer to set up password-free connections with an ssh key. For them, instead of using the last line above, contributors might want to use ssh-based cloning:
```bash
pip install -e git+ssh://[email protected]/usnistgov/mass.git#egg=mass
```

Expand Down Expand Up @@ -192,4 +198,4 @@ Change directory into `doc`, then:
Read about RST (reStructuredText) format. It is weird. My most common mistake is forgetting the blank line between `.. blah` statements and the following text. See the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) for details about its syntax.

# massGui, the GUI for Mass
massGui is an attempt to bring the core features of Mass into a graphical user interface (GUI). You can find more information and install it at [https://github.com/gmondee/massGui](https://github.com/gmondee/massGui).
massGui is an attempt to bring the core features of Mass into a graphical user interface (GUI). You can find more information and install it at [https://github.com/gmondee/massGui](https://github.com/gmondee/massGui).
1 change: 1 addition & 0 deletions VERSIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
**0.8.5** July 2024-

* Fix problem where numpy 2.0 was failing a regression test. Not a true regression, so we broaden the acceptance criteria (issue 295).
* Add installation instructions to README for https-based installation, in addition to ssh-based.

**0.8.4** June 5, 2024

Expand Down