Updated README so that it contains install instructions #1056
Conversation
This file contains 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
marcus-oscarsson
force-pushed
the
develop
branch
2 times, most recently
from
946d75c
to
5477aec
Compare
marcus-oscarsson
force-pushed
the
mo-readme
branch
from
6742545
to
e171f79
Compare
beteva
reviewed
Sep 26, 2023
README.md
Outdated
Comment on lines
8
to
11
|
|
||
|
|
||
| MXCuBE-Web is the latest generation of the data acquisition software MXCuBE (Macromolecular Xtallography Customized Beamline Environment). | ||
|
|
beteva
reviewed
Sep 26, 2023
README.md
Outdated
Comment on lines
81
to
98
| ### 3. Create Conda environment `mxcubeweb` | ||
| Create Conda environment `mxcubeweb` using the conda environment file in mxcubeweb. The installation of the dependencies in the environment takes a few minutes. | ||
|
|
||
| The name of the environment is located at the top of file `conda-environment.yml`. It can be changed from the command line with `--name <env-name>`. | ||
|
|
||
| ``` | ||
| cd mxcubeweb | ||
| conda env create -f conda-environment.yml | ||
| # or (to pass a different name) | ||
| conda env create -f conda-environment.yml --name another_name | ||
| ``` | ||
|
|
||
| ### 4. Activate the environment | ||
|
|
||
| ``` | ||
| conda activate mxcubeweb | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Do we oblige to use conda or we strongly recommend it, but leave it optional?
There was a problem hiding this comment.
Id say that we recommend it but one is of course free to choose another way of installing things
There was a problem hiding this comment.
In this case, maybe we say something like - We use conda for a convenience and to be independent from other projects libraries and python version. This, though, is not compulsory and one can use any other tool or configuration for installing the application and the necessary third party libraries.
meguiraun
approved these changes
Sep 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Moved install instructions to README. We can then remove the wiki page when merged