Skip to content

Commit e7b9e66

Browse files
committed
more install details in docs. thanks hiroshi shiozaki!
1 parent 8bb7a91 commit e7b9e66

1 file changed

Lines changed: 33 additions & 3 deletions

File tree

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2093,6 +2093,11 @@ library, set XLA_FLAGS in your environment, and install cuda-nvcc:
20932093
>> $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
20942094
$ conda install -c nvidia cuda-nvcc
20952095

2096+
To launch the SongExplorer GUI from this installation:
2097+
2098+
$ conda activate songexplorer
2099+
$ <path-to-songexplorer-repo>/src/songexplorer <path-to-songexplorer-repo>/configuration.py 8080
2100+
20962101
To upload to the [Janelia forge](https://anaconda.org/janelia):
20972102

20982103
$ conda activate base
@@ -2122,12 +2127,37 @@ asset:
21222127

21232128
$ openssl sha256 <github-tar-gz-file>
21242129

2125-
To upload a tarball to Github, compress the conda environment and drag and drop
2126-
it into the assets section of the releases page:
2130+
To upload a tarball to Github, package the conda environment, bundle it with
2131+
the default configuration file and a launch script, and drag and drop it into
2132+
the assets section of the releases page. When installed with this method,
2133+
users simply open the launch script in the OS's GUI instead of using the
2134+
command line method above.
21272135

21282136
$ conda activate base
21292137
$ conda install -c conda-forge conda-pack
2130-
$ conda-pack -n songexplorer -o songexplorer-<version>-<architecture>.tar.gz
2138+
$ conda-pack -n songexplorer -o songexplorer.tar.gz
2139+
$ mkdir -p songexplorer-<version>-<architecture>/songexplorer
2140+
$ tar xvzf songexplorer.tar.gz -C songexplorer-<version>-<architecture>/songexplorer
2141+
$ cp <path-to-songexplorer-repo>/configuration.py songexplorer-<version>-<architecture>
2142+
$ cp <path-to-songexplorer-repo>/app/OPEN-WITH-TERMINAL.sh songexplorer-<version>-<architecture> # for macOS
2143+
$ cp <path-to-songexplorer-repo>/app/RUN-WITH-POWERSHELL.ps1 songexplorer-<version>-<architecture> # for Windows
2144+
$ tree -L2 songexplorer-<version>-<architecture>
2145+
songexplorer-v0.9.1-osx-arm64
2146+
├── configuration.py
2147+
├── OPEN-WITH-TERMINAL.sh # RUN-WITH-POWERSHELL.ps1 on Windows
2148+
└── songexplorer
2149+
├── bin
2150+
├── cmake
2151+
├── conda-meta
2152+
├── etc
2153+
├── include
2154+
├── lib
2155+
├── libexec
2156+
├── man
2157+
├── sbin
2158+
├── share
2159+
└── ssl
2160+
$ tar cvzf songexplorer-<version>-<architecture>.tar.gz songexplorer-<version>-<architecture>
21312161

21322162
After downloading, some users will need to re-install some pip dependencies
21332163
(e.g. tensorflow-metal on MacOS) as they are not in general relocatable:

0 commit comments

Comments
 (0)