Skip to content

Commit

Permalink
Merge branch 'main' into joshkamm/issue73
Browse files Browse the repository at this point in the history
  • Loading branch information
joshkamm authored Aug 8, 2024
2 parents b6cd7de + 46c708e commit 205c0e2
Show file tree
Hide file tree
Showing 5 changed files with 4,299 additions and 6 deletions.
2 changes: 2 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "pipx install --user -r requirements.txt",
"postCreateCommand": {
"install pixi": "curl -fsSL https://pixi.sh/install.sh | bash",
"pixi install": "pixi install",
"install uv": "curl -LsSf https://astral.sh/uv/install.sh | sh",
"add uv to PATH": "source $HOME/.cargo/env",
"create venv": "uv venv",
Expand Down
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,8 @@ src/*.egg-info
#scratch files from the examples
/examples/*/scratch/*
/examples/*/conformers*
/examples/*/output.txt
/examples/*/output.txt

# pixi environments
.pixi
*.egg-info
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,12 @@ pip install -e .
## Conda (alternative) installation

* Clone GitHub repository.
* Create a conda environment in which to install this library (links to more information on [anaconda installation](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and [anaconda environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)). The following command creates a new conda environment with python and a couple dependencies that the author was unable to install automatically using pip (see below).
* Create a conda environment in which to install this library (links to more information on [anaconda installation](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and [anaconda environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)). The following command creates a new conda environment with python.

```
conda create -c conda-forge --name conformational-sampling python openbabel xtb-python
conda create -c conda-forge --name conformational-sampling python=3.11
```

Note: in the author's environment, manually compiling a version of xTB was found to run a few times faster than the precompiled binary from conda used in these instructions.

* Activate the conda environment.

```
Expand Down
Loading

0 comments on commit 205c0e2

Please sign in to comment.