WIP: Update installation instructions #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntolley
changed the title
asoplata
added a commit
to asoplata/hnn
that referenced
this pull request
Apr 24, 2025
This updates the documented HNN-original installation methods for most platforms to a newer version based on jonescompneurolab#337 . This is necessary because: 1. The most recent install instructions found on the official HNN website https://hnn.brown.edu/installation-instructions/ provide only either a link to jonescompneurolab#337 or, in Oscar's case, a separate set of instructions. However, these webpages on the official HNN website will soon be deleted, since we will soon be doing a comprehensive overhaul of the HNN websites. Once this happens, the only guidance that users will receive about installation will need to be present on the README of the repository here https://github.com/jonescompneurolab/hnn 2. The Installation page indicated on the README of the repository https://github.com/jonescompneurolab/hnn does NOT include the install guidance from jonescompneurolab#337. This PR takes the old pre-existing instructions for each platform, moves them into respective subdirectories such as `2021_instructions` (the last year they were updated), and then updates most of the instructions for each platform to match jonescompneurolab#337. I successfully tested the updated install versions for brown_ccv, mac, ubuntu, and windows, and was able to get them all working using the provided instructions. For Mac and Windows, I built off of jonescompneurolab/hnn-tutorials#4 This also adds a disclaimer at the top of every install page that redirects users to HNN-Core. Even people in the lab have still been getting confused about which install instructions are for which version (original HNN or HNN-Core), so that should be cleared up now.
ntolley
pushed a commit
to jonescompneurolab/hnn
that referenced
this pull request
Oct 28, 2025
* Relocate pre-existing install instructions * Update installation instructions, add caveat This updates the documented HNN-original installation methods for most platforms to a newer version based on #337 . This is necessary because: 1. The most recent install instructions found on the official HNN website https://hnn.brown.edu/installation-instructions/ provide only either a link to #337 or, in Oscar's case, a separate set of instructions. However, these webpages on the official HNN website will soon be deleted, since we will soon be doing a comprehensive overhaul of the HNN websites. Once this happens, the only guidance that users will receive about installation will need to be present on the README of the repository here https://github.com/jonescompneurolab/hnn 2. The Installation page indicated on the README of the repository https://github.com/jonescompneurolab/hnn does NOT include the install guidance from #337. This PR takes the old pre-existing instructions for each platform, moves them into respective subdirectories such as `2021_instructions` (the last year they were updated), and then updates most of the instructions for each platform to match #337. I successfully tested the updated install versions for brown_ccv, mac, ubuntu, and windows, and was able to get them all working using the provided instructions. For Mac and Windows, I built off of jonescompneurolab/hnn-tutorials#4 This also adds a disclaimer at the top of every install page that redirects users to HNN-Core. Even people in the lab have still been getting confused about which install instructions are for which version (original HNN or HNN-Core), so that should be cleared up now. * docker: add ssh port fix This applies Dylan's fix to today's issue with Mac usage of the suggested installation instructions, as mentioned in this comment: #346 (comment) The cause of the bug appears to be thus: in `scripts/docker_functions.sh`, `get_container_port()` and elsewhere depends on identifying the port of the HNN container for use. However, the current combination of `cut` and a regex assume from the use of a command like ``` docker port hnn_container 22 ``` as used here: https://github.com/jonescompneurolab/hnn/blob/e0cf45f876761280062511b56e7de088e7950b01/scripts/docker_functions.sh#L617 would output something like ``` 0.0.0.0:49669 ::49669 ``` possibly excluding the second line, I'm not sure. The first line is an IPv4 version of the container's local IP and its port, and the second is an IPv6 version. However, even though the documention doesn't make mention of the IPv6 output ( https://docs.docker.com/reference/cli/docker/container/port/ ), it appears that as part of Docker Engine v28 https://docs.docker.com/engine/release-notes/28/#2800 the IPv6 output was changed to include brackets. This now affects current use of `docker port`. For example, on my current up-to-date version of Docker Desktop (using Docker Engine Community 28.4.0), running `docker port hnn_container 22` gives me the following output: ``` 0.0.0.0:49669 [::]:49669 ``` The new brackets displayed, and/or the IPv6 output displayed, break the bash scripting we use to identify the port. The new bash scripting in this commit should fix this. * doc: tiny windows instruction edition * doc: fix ubuntu install issues
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal of this PR is to replace the website's installation instructions with those specified here: jonescompneurolab/hnn#337