Skip to content

Commit

Permalink
Update release info.
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacrobinson2000 committed Dec 20, 2023
1 parent fc58bad commit fc6aaab
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 18 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@ DIPLOMAT also includes a UI for performing tracking and several other tools for
To install DIPLOMAT with PIP right now, you can and install it with pip using one of the following commands below:
```bash
# For working with SLEAP projects:
pip install "diplomat-track[sleap] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[sleap]
# For working with DeepLabCut projects:
pip install "diplomat-track[dlc] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[dlc]
```
To install DIPLOMAT with GUI elements and supervised tracking support, use one of the commands below:
```bash
# For using DIPLOMAT with SLEAP
pip install "diplomat-track[sleap, gui] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[sleap, gui]
# Again, replace sleap with dlc to install with DeepLabCut support.
pip install "diplomat-track[dlc, gui] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[dlc, gui]
```

**NOTE:** DIPLOMAT also includes two environment configuration files for setting up DIPLOMAT with
Expand Down
15 changes: 10 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# Release Instructions

**REPLACE:** How does one generate a new release of the software? Ideally, this
should be an automated process, but there may still be a handful of steps. It is
also good to describe, at a high level, what the release script does. For
example, create a Git tag, increment the version number in a particular file,
create a release on GitHub, and so on.
DIPLOMAT is setup to be easy to release, using Github-Actions. To release a new DIPLOMAT version, the following
steps can be followed.
1. Update `RELEASE_NOTES.md` to list the latest features in DIPLOMAT.
2. Modify DIPLOMAT's `__init__.py` file (located at `diplomat/__init__.py`) to increase the version number.
This is done by modifying the `__version__` variable in the file to a new semver, such as `"1.0.1"`.
3. Commit your changes, and push them to the `main` branch. This can be done by:
- Manually pushing to the main branch.
- Creating, and merging a GitHub Pull-Request.

Once done, the GitHub action hooks will automatically detect the new version change, and create a new pypi version
and release on GitHub (including a tag for the version).
4 changes: 3 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ Changes in this version of diplomat:
so a full in memory run can be done by setting the `storage_mode` setting to `"memory"`.
- New `diplomat restore` command for restoring the UI from `.dipui` files. This requires running predictions with the
storage mode set to `"disk"`, which is the default now.
- New installation process with mamba that is more consistent and stable across platforms.
- New installation process with mamba that is more consistent and stable across platforms.
- New pypi package, `diplomat-track`.
-
3 changes: 1 addition & 2 deletions conda-environments/DIPLOMAT-DEEPLABCUT.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@ dependencies:
- jupyter
- ffmpeg
- wxpython
- git
- numpy<=1.20
- numba
- tensorflow-gpu
- keras
- pip:
- deeplabcut
- "diplomat-track @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
- diplomat-track
3 changes: 1 addition & 2 deletions conda-environments/DIPLOMAT-SLEAP.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ dependencies:
- pip
- sleap
- wxpython
- git
- pip:
- "diplomat-track @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
- diplomat-track
- "wheel==0.35" # The conda one appears to be broken...
8 changes: 4 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ DIPLOMAT with DeepLabCut support by simply using pip, using one of the two comma
.. code-block:: sh
# Install DIPLOMAT with DeepLabCut with GUI support.
pip install "diplomat-track[dlc, gui] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[dlc, gui]
# Install DIPLOMAT with DeepLabCut without UI support.
pip install "diplomat-track[dlc] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[dlc]
With Support for SLEAP Projects
Expand Down Expand Up @@ -110,6 +110,6 @@ trying to install DIPLOMAT with SLEAP support on Windows, prefer using the mamba
.. code-block:: sh
# Install DIPLOMAT with SLEAP with GUI support.
pip install "diplomat-track[sleap, gui] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[sleap, gui]
# Install DIPLOMAT with SLEAP without UI support.
pip install "diplomat-track[sleap] @ git+https://github.com/TravisWheelerLab/DIPLOMAT.git"
pip install diplomat-track[sleap]

0 comments on commit fc6aaab

Please sign in to comment.