Skip to content

Commit f45e605

Browse files
PicoCentauriLuthaf
authored andcommitted
Fix links to new repo location and typos
This PR changes all links to the new location of the repository. Additionally pybind11 is now written consistently and according to their naming convention.
1 parent 6f7a400 commit f45e605

12 files changed

+28
-26
lines changed

.circleci/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ jobs:
105105
if [[ $CIRCLE_BRANCH == "master" ]]; then
106106
./.circleci/deploy-docs.sh
107107
cd gh-pages
108-
git push -q https://${GH_TOKEN}@github.com/cosmo-epfl/librascal.git gh-pages
108+
git push -q https://${GH_TOKEN}@github.com/lab-cosmo/librascal.git gh-pages
109109
fi
110110
111111
# Special job only linting the code

CONTRIBUTING.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ linter fails on your code, the pull request will be sent back for revision
1414
without any further comments.
1515

1616
It is also a good idea to browse the
17-
`developer's guide <https://cosmo-epfl.github.io/librascal/dev_guide/developer.html>`_,
17+
`developer's guide <https://lab-cosmo.github.io/librascal/dev_guide/developer.html>`_,
1818
especially the
19-
`coding conventions <https://cosmo-epfl.github.io/librascal/dev_guide/coding-convention.html>`_
19+
`coding conventions <https://lab-cosmo.github.io/librascal/dev_guide/coding-convention.html>`_
2020
for C++ code (Python code generally follows PEP 8).
2121

2222
We now have a pull request template; please use it (especially for new
@@ -32,7 +32,7 @@ Summary of the review process
3232
===============================
3333

3434
A detailed description can be found in a separate document about the `review
35-
process <https://cosmo-epfl.github.io/librascal/dev_guide/review_process.html>`_
35+
process <https://lab-cosmo.github.io/librascal/dev_guide/review_process.html>`_
3636

3737
For developers
3838
* We want a clean and tested master branch, which is why we review code and use
@@ -69,7 +69,7 @@ sent back without further comments. The two exceptions to this rule are:
6969
those outputs from making it into the history in the first place)
7070

7171
2. Stable outputs for example notebooks meant to be processed to HTML for the
72-
`tutorials page <https://cosmo-epfl.github.io/librascal/tutorials/tutorials.html>`_.
72+
`tutorials page <https://lab-cosmo.github.io/librascal/tutorials/tutorials.html>`_.
7373
"Stable" here means these are the final outputs meant to be shown to the
7474
public and won't be changed unless errors or omissions are discovered, or the
7575
tutorial is later updated or expanded. Note that tutorials that rely on

README.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ librascal is currently considered a standalone code. However, we aim to
1414
provide enough flexibility to interface it with other codes such as
1515
LAMMPS and PLUMED-2.0. It can be used as a C++ library as well as a
1616
python module. To be able to call it from python, we have used the
17-
pybind11 library.
17+
pybind11_ library.
1818

1919
Although at the moment is a serial-only code, we aim to write it in MPI
2020
so that it will be possible to take advantage of parallelization to
@@ -30,7 +30,8 @@ distributed, although we take no responsibility for its misuse.
3030

3131
For more information, have a look at the documentation_!
3232

33-
.. _documentation: https://cosmo-epfl.github.io/librascal/
33+
.. _documentation: https://lab-cosmo.github.io/librascal/
34+
.. _pybind11: https://pybind11.readthedocs.io
3435

3536
Development
3637
-----------
@@ -84,7 +85,7 @@ following packages installed:
8485
| ASE | 3.18 or higher |
8586
+-------------+--------------------+
8687

87-
Other necessary packages (such as Eigen and PyBind11) are downloaded
88+
Other necessary packages (such as Eigen and pybind11) are downloaded
8889
automatically when compiling Rascal.
8990

9091
The following packages are required for some optional features:
@@ -114,7 +115,7 @@ supporting C++14. During the configuration, it will automatically try to
114115
download the external libraries on which it depends:
115116

116117
- Eigen
117-
- Pybind11
118+
- pybind11
118119
- Boost (only the unit test framework library)
119120
- Python3
120121

@@ -340,7 +341,7 @@ in version control. Use them only for tutorials or *stable* examples that
340341
are either meant to be run *interactively* or are meant to be processed by
341342
`sphinx` (`nbsphinx <https://nbsphinx.readthedocs.io/en/latest/>`_) for
342343
inclusion in the
343-
`tutorials page <https://cosmo-epfl.github.io/librascal/tutorials/tutorials.html>`_.
344+
`tutorials page <https://lab-cosmo.github.io/librascal/tutorials/tutorials.html>`_.
344345

345346
Miscellaneous Information
346347
-------------------------

docs/source/index.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ are written in C++14, and are collected in the :file:`/src/` directory, as in th
2626
case of the :cpp:func:`cdist <cdist>`. This folder is completely agnostic of the
2727
python bindings, and it should be kept in this way.
2828

29-
The python-bindings is obtained through Pybind11, and the binding subroutines
29+
The python-bindings is obtained through the pybind11 library,
30+
and the binding subroutines
3031
are included in the :file:`/bindings/` folder. Here, the bind_py_module.cc is
3132
the file that contains the main binding of the C++ package (in other words, is
3233
what is needed to use the syntax :python:`import librascal`). The binding for
3334
each submodule of Rascal and its members are collected in files named
34-
bind_py_METHOD.cc. We decided to employ Pybind11 because of its seamless
35+
bind_py_METHOD.cc. We decided to employ pybind11 because of its seamless
3536
integration between Eigen and numpy. This allows the developer (and the user) to
3637
code fast and efficient algorithms easily, without losing the power of the C++
3738
linear algebra as well as numpy simplicity. For more reference, please consult

docs/source/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It is strongly recommended to clone librascal from its repository in GitHub.
1010

1111
.. code-block:: bash
1212
13-
git clone https://github.com/cosmo-epfl/librascal.git
13+
git clone https://github.com/lab-cosmo/librascal.git
1414
1515
1616
.. include:: ../../README.rst

docs/source/user_guide/running_md.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ powerful and flexible simulation engine, capable of many advanced simulation
1919
techniques such as REMD and PIMD and parallel execution of multiple system
2020
replicas. It is possible to use ``librascal`` as a "force driver" within i-PI's
2121
socket calculator interface: Use `this driver script (on github)
22-
<https://github.com/cosmo-epfl/i-pi/blob/feat/librascal/drivers/py/pes/rascal.py>`_
22+
<https://github.com/lab-cosmo/i-pi/blob/feat/librascal/drivers/py/pes/rascal.py>`_
2323
to initialize a saved ``librascal`` model, then run i-PI to connect to the
2424
socket and run dynamics. Please consult the i-PI documentation for further
2525
information on setting up a simulation and using socket calculators.
@@ -47,7 +47,7 @@ Others
4747

4848
If you would like ``librascal`` to support another MD code, please let us know!
4949
The best way to do this is `open an issue on our github
50-
<https://github.com/cosmo-epfl/librascal/issues>`_ with the ``enhancement``
50+
<https://github.com/lab-cosmo/librascal/issues>`_ with the ``enhancement``
5151
label.
5252

5353
In the meantime, if you can make your MD code call Python code, you may be able

examples/MLIP_example.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"# a collection of distorted ethanol molecules from the ANI-1 dataset \n",
5151
"# (see https://github.com/isayev/ANI1_dataset) with energies and forces computed using DFTB+ \n",
5252
"# (see https://www.dftbplus.org/)\n",
53-
"url = 'https://raw.githubusercontent.com/cosmo-epfl/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
53+
"url = 'https://raw.githubusercontent.com/lab-cosmo/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
5454
"# Download the file from `url`, save it in a temporary directory and get the\n",
5555
"# path to it (e.g. '/tmp/tmpb48zma.txt') in the `structures_fn` variable:\n",
5656
"structures_fn, headers = urllib.request.urlretrieve(url)\n",

examples/equivariant_demo.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
"# a collection of distorted allyl alcohol molecules from the ANI-1 dataset \n",
8989
"# (see https://github.com/isayev/ANI1_dataset) with energies and forces computed using DFTB+ \n",
9090
"# (see https://www.dftbplus.org/)\n",
91-
"url = 'https://raw.githubusercontent.com/cosmo-epfl/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
91+
"url = 'https://raw.githubusercontent.com/lab-cosmo/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
9292
"# Download the file from `url`, save it in a temporary directory and get the\n",
9393
"# path to it (e.g. '/tmp/tmpb48zma.txt') in the `structures_fn` variable:\n",
9494
"structures_fn, headers = urllib.request.urlretrieve(url)\n",

examples/needs_updating/Spherical_invariants_and_database_exploration.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"# a collection of distorted ethanol molecules from the ANI-1 dataset \n",
6161
"# (see https://github.com/isayev/ANI1_dataset) with energies and forces computed using DFTB+ \n",
6262
"# (see https://www.dftbplus.org/)\n",
63-
"url = 'https://raw.githubusercontent.com/cosmo-epfl/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
63+
"url = 'https://raw.githubusercontent.com/lab-cosmo/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
6464
"# Download the file from `url`, save it in a temporary directory and get the\n",
6565
"# path to it (e.g. '/tmp/tmpb48zma.txt') in the `structures_fn` variable:\n",
6666
"structures_fn, headers = urllib.request.urlretrieve(url)\n",

examples/nice_demo.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
"# a collection of distorted allyl alcohol molecules from the ANI-1 dataset \n",
5959
"# (see https://github.com/isayev/ANI1_dataset) with energies and forces computed using DFTB+ \n",
6060
"# (see https://www.dftbplus.org/)\n",
61-
"url = 'https://raw.githubusercontent.com/cosmo-epfl/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
61+
"url = 'https://raw.githubusercontent.com/lab-cosmo/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
6262
"# Download the file from `url`, save it in a temporary directory and get the\n",
6363
"# path to it (e.g. '/tmp/tmpb48zma.txt') in the `structures_fn` variable:\n",
6464
"structures_fn, headers = urllib.request.urlretrieve(url)\n",
@@ -662,7 +662,7 @@
662662
"cell_type": "markdown",
663663
"metadata": {},
664664
"source": [
665-
"Given that the number of features grows exponentially with body order, some kind of truncation must be applied. NICE features incorporate a Contraction step to compress information at each body order iteration. See the [NICE library](https://github.com/cosmo-epfl/nice/) for a full-fledged implementation. \n",
665+
"Given that the number of features grows exponentially with body order, some kind of truncation must be applied. NICE features incorporate a Contraction step to compress information at each body order iteration. See the [NICE library](https://github.com/lab-cosmo/nice/) for a full-fledged implementation. \n",
666666
"\n",
667667
"One way to check the amount of information that is lost due to truncation of the NICE iteration (or of the basis set!) is to apply the sum rule from [Goscinski et al. (2021)](https://arxiv.org/pdf/2105.08717), which is a consequence of the orthogonality of CG coefficients. Basically, _for each environment_ the norm of the full $\\nu$-neighbors feature vector is equal to the norm of the $\\nu=1$ equivariants (the density expansion coefficients) raised to the power $\\nu$. Note the norm is to be intended over all equivariant terms, i.e.\n",
668668
"$$\n",

examples/optimized_radial_basis_functions.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"# a collection of distorted ethanol molecules from the ANI-1 dataset \n",
6161
"# (see https://github.com/isayev/ANI1_dataset) with energies and forces computed using DFTB+ \n",
6262
"# (see https://www.dftbplus.org/)\n",
63-
"url = 'https://raw.githubusercontent.com/cosmo-epfl/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
63+
"url = 'https://raw.githubusercontent.com/lab-cosmo/librascal-example-data/833b4336a7daf471e16993158322b3ea807b9d3f/inputs/molecule_conformers_dftb.xyz'\n",
6464
"# Download the file from `url`, save it in a temporary directory and get the\n",
6565
"# path to it (e.g. '/tmp/tmpb48zma.txt') in the `structures_fn` variable:\n",
6666
"structures_fn, headers = urllib.request.urlretrieve(url)\n",

examples/zundel_i-PI.ipynb

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"The present notebook is meant to give you an overview of the main ingredients that you need to build an interatomic potential with `librascal` and use it in connection with i-Pi (https://github.com/cosmo-epfl/i-pi) to generate molecular dynamics (MD) trajectories of the system of interest. \n",
14+
"The present notebook is meant to give you an overview of the main ingredients that you need to build an interatomic potential with `librascal` and use it in connection with i-Pi (https://github.com/lab-cosmo/i-pi) to generate molecular dynamics (MD) trajectories of the system of interest. \n",
1515
"We will start from building a GAP model for Zundel cations ($H_5O_2+$), using a training set obtained via Bowman PES sampling, calculate its RMSE on a test set to check its performance and run a short NVT simulation at $\\text{T} = 250\\,\\text{K}$. \n",
1616
"\n",
1717
"The mathematical framework that we are going to use is the kernel-GAP fitting method, using both total energies and atomic forces as target properties. Basically the GAP-model total energy of a zundel molecule is computed using the following expression: \n",
@@ -47,12 +47,12 @@
4747
"source": [
4848
"In order to be able to fit a potential with `librascal` (the model evaluator) and interface it with i-Pi (the MD engine) we first need to have both softwares available and correctly installed. For `librascal`, the following should suffice:\n",
4949
"```bash\n",
50-
"$ pip install git+https://github.com/cosmo-epfl/librascal.git\n",
50+
"$ pip install git+https://github.com/lab-cosmo/librascal.git\n",
5151
"```\n",
5252
"\n",
5353
"and the same for i-PI:\n",
5454
"```bash\n",
55-
"$ pip install git+https://github.com/cosmo-epfl/i-pi.git\n",
55+
"$ pip install git+https://github.com/lab-cosmo/i-pi.git\n",
5656
"```\n",
5757
"If these steps don't work, try looking at the `README.rst` files of the respective repositories for further instructions."
5858
]
@@ -247,7 +247,7 @@
247247
"cell_type": "markdown",
248248
"metadata": {},
249249
"source": [
250-
"Now we proceed with the actual calculation of the SOAP vectors of our training set. We need to specify an hyperparameters dictionary, which `librascal` uses to compute the structural features. The meaning of each hyperparameter and how to correctly set them is reported in [the `SphericalInvariants` documentation](https://cosmo-epfl.github.io/librascal/reference/python.html#rascal.representations.SphericalInvariants). These hyperparameters can be used as default values, but a careful optimization of the interaction cutoff might be required in the case the material under investigation might present some mid- or long-range order. \n",
250+
"Now we proceed with the actual calculation of the SOAP vectors of our training set. We need to specify an hyperparameters dictionary, which `librascal` uses to compute the structural features. The meaning of each hyperparameter and how to correctly set them is reported in [the `SphericalInvariants` documentation](https://lab-cosmo.github.io/librascal/reference/python.html#rascal.representations.SphericalInvariants). These hyperparameters can be used as default values, but a careful optimization of the interaction cutoff might be required in the case the material under investigation might present some mid- or long-range order. \n",
251251
"\n",
252252
"For the actual calculation of the SOAP features, we first create an object of the `SphericalInvariants` class, defined by its hyperparameters. The methods that we then need to use are `transform()}`, which yields a second object called the `manager` containing the representation, while `get_features()` converts it into an $NxM$ matrix, $N$ being the number of atomic environments in the training set and M the number of features per each environment. \n",
253253
"\n",
@@ -632,7 +632,7 @@
632632
"source": [
633633
"Now we are going to use the fitted model to perform a simple NVT simulation at $\\text{T} = 250\\,$K using the i-Pi interface with librascal. For that we will use a communication socket run by i-Pi, which basically outputs a structure produced by the MD and gives it in input to Librascal. This will in turn return energies, forces and stresses by means of the `GenericMDCalculator` class of Librascal. \n",
634634
"\n",
635-
"The job itself will generate a parent process (i-Pi) which contains information of the ensemble, the step needed for the time-integration, the thermostat characteristics, and all other trajectory-related infos. All these information are initially stored in an input.xml file as specified in the i-Pi documentation at https://github.com/cosmo-epfl/i-pi and given as inputs to i-Pi. The Librascal calculator is then launched as a child process and exchanges information with the MD driver. \n",
635+
"The job itself will generate a parent process (i-Pi) which contains information of the ensemble, the step needed for the time-integration, the thermostat characteristics, and all other trajectory-related infos. All these information are initially stored in an input.xml file as specified in the i-Pi documentation at https://github.com/lab-cosmo/i-pi and given as inputs to i-Pi. The Librascal calculator is then launched as a child process and exchanges information with the MD driver. \n",
636636
"\n",
637637
"The Librascal driver in i-Pi needs some input parameters, that can be given directly in the command line when the driver is called. To check the needed information, just use the --help option when calling it, as shown below.\n",
638638
"\n",

0 commit comments

Comments
 (0)