From 14f71e5e010d5ab3893a0c2b0d6e234e0dc709ef Mon Sep 17 00:00:00 2001 From: Marco Giulini <54807167+mgiulini@users.noreply.github.com> Date: Tue, 6 Feb 2024 12:34:39 +0100 Subject: [PATCH] Prettier readmes (#385) * Update README.md * Update CONTRIBUTING.md * added space --- CONTRIBUTING.md | 2 -- README.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d67ca2..156ec0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,5 @@ # Developing ARCTIC-3D -This section is still work in progress - ## Installation We use `poetry` to manage the dependencies and the virtual environment, so it makes things easier if you need to install it first; check the [official documentation](https://python-poetry.org/docs/#installation) for more details. diff --git a/README.md b/README.md index 437648f..f3c5138 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,15 @@ Check [CONTRIBUTING.md](CONTRIBUTING.md) for more information. ### With `conda` +Clone the repository on your computer and navigate to it + +```bash +git clone git@github.com:haddocking/arctic3d.git +cd arctic3d +``` + +Here you can create the arctic3d environment: + ```bash conda create -n arctic3d python=3.10 conda activate arctic3d @@ -59,3 +68,9 @@ sphinx-build -E docs ./arctic3d-docs ``` Then you can open the file `arctic3d-docs/index.html`, which contains all the necessary documentation. + +## Citing us + +If you used ARCTIC-3D in your work please cite the following publication: + +**Marco Giulini, Rodrigo V. Honorato, Jesús L. Rivera, and Alexandre MJJ Bonvin**: "ARCTIC-3D: automatic retrieval and clustering of interfaces in complexes from 3D structural information." Communications Biology 7, no. 1 (2024): 49. (www.nature.com/articles/s42003-023-05718-w)