From ad7226fbc37ae68e4c34a5105a9d42dbd4defc1b Mon Sep 17 00:00:00 2001 From: Chris Liao <33707455+liaochris@users.noreply.github.com> Date: Wed, 25 Mar 2026 10:09:08 -0400 Subject: [PATCH 1/2] software agnostic readme #144 --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b20b4a7..cad4117 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A template for research projects developed by JMSLab. ### Prerequisites -- We recommend installing Python via [Anaconda](https://www.anaconda.com/products/individual). +- A Python distribution (for example, [Anaconda](https://www.anaconda.com/products/individual) or [CPython](https://www.python.org/downloads/)) - We use Python to run [SCons](https://scons.org); custom SCons builders are also written in Python. - You will need to install the dependencies in `source/lib/requirements.txt` (including SCons). See [quick start](#quick-start) below. - [git](https://git-scm.com/downloads) for version control. @@ -54,13 +54,13 @@ In addition, each project may use other specialized tools. For the working examp - Do _not_ link a "live" copy of the datastore (i.e. one that is synchronized to the internet). Work with a local, off-line copy before modifying the live copy; otherwise the data may get unintentionally overwritten for everyone using the datastore. -3. Install dependencies: +3. Create an isolated Python environment and install the dependencies listed in `source/lib/requirements.txt`. - ``` - pip install -r source/lib/requirements.txt - ``` + For example, you can use: + - separate tools for environment and package management, such as `venv` + `pip` + - an integrated tool, such as `conda` or `uv` - (If using `conda`, run `conda install --file source/lib/requirements.txt`.) Requirements for other languages, should there be any, will be found in `source/lib/requirements.{ext}` with `{ext}` equal to `do` (Stata), `r` (R), `m` (Matlab), and so on. + Requirements for other languages, should there be any, will be found in `source/lib/requirements.{ext}` with `{ext}` equal to `do` (Stata), `r` (R), `m` (Matlab), and so on. 4. Make sure that all the required program executables are in your system's path. From 534c6f071412a1aa340fff703a5c8971d19db393 Mon Sep 17 00:00:00 2001 From: jmshapir Date: Wed, 25 Mar 2026 15:49:18 -0400 Subject: [PATCH 2/2] Formatting for #144 --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d8c113e..c569717 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,11 @@ In addition, each project may use other specialized tools. For the working examp 3. Create an isolated Python environment and install the dependencies listed in `source/lib/requirements.txt`. - For example, you can use: - - separate tools for environment and package management, such as `venv` + `pip` - - an integrated tool, such as `conda` or `uv` + - For example, you can use: + - separate tools for environment and package management, such as `venv` + `pip` + - an integrated tool, such as `conda` or `uv` - Requirements for other languages, should there be any, will be found in `source/lib/requirements.{ext}` with `{ext}` equal to `do` (Stata), `r` (R), `m` (Matlab), and so on. + - Requirements for other languages, should there be any, will be found in `source/lib/requirements.{ext}` with `{ext}` equal to `do` (Stata), `r` (R), `m` (Matlab), and so on. 4. Make sure that all the required program executables are in your system's path.