diff --git a/README.md b/README.md index d7fb413..829198f 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ model.compare(dataset) # See how the simulated and measured patterns compare plt.show() ``` -Full installation instructions and documentation can be found [here](https://allevitan.github.io/cdtools-docs/). +Full installation instructions and documentation can be found [here](https://cdtools-developers.github.io/cdtools-docs/). CDTools was developed in the [photon scattering lab](https://scattering.mit.edu/) at MIT, and further development took place within the [computational x-ray imaging group](https://www.psi.ch/en/cxi) at PSI. If you would like to publish any work that uses CDTools, please contact [Abe Levitan](mailto:abraham.levitan@psi.ch). diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 5eef800..a92a322 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -4,12 +4,11 @@ Installation Step 1: Download ---------------- -The source code for CDTools is hosted on it's `MIT github page`_. Access to the MIT github page can be granted to any member of the MIT community. If you are not a member, access can also be arranged through a `private github tracking repository`_, by contacting `Abe Levitan `_. +The source code for CDTools is hosted on `Github`_. At the moment, the repository remains private while we decide on licensing. Access can be granted upon request by contacting `Abe Levitan `_. -.. _`MIT github page`: https://github.mit.edu/Scattering/cdtools -.. _`private github tracking repository`: https://github.com/allevitan/cdtools +.. _`Github`: https://github.com/cdtools-developers/cdtools -It is recommended that you clone the repository, rather than just downloading the contents, as it remains under active development. Cloning the repository will allow you to easily get access to new updates, bug fixes, etc. +The repository remains under active development as of late 2024. Step 2: Install Dependencies ---------------------------- @@ -47,6 +46,7 @@ Optional dependencies: The file "example_environment.yml", included in the repository's top level directory, contains an example of an environment with all dependencies properly installed on a linux machine with a GPU, circa early 2024. + Step 3: Install --------------- @@ -74,4 +74,4 @@ To ensure that the installation has worked correctly, it is recommended that you $ pytest -If any tests fail, make sure that you have all the noted dependencies properly installed. If you do, and things still aren't working, `send me (Abe Levitan) an email `_ and we'll get to the bottom of it. +If any tests fail, make sure that you have all the noted dependencies properly installed. If you do, and things still aren't working, `send me (Abe Levitan) an email `_ and we'll get to the bottom of it. CDTools has been tested on linux and mac, on CPU, CUDA, and MPS.