diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06ad387edb3200b58c07a608298af55884f2e21d..93df75caef0cf411106eb4df97554ceceb5c1546 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ There are many ways to contribute: writing tutorials or blog posts, improving th documentation, submitting bug reports and feature requests or writing code which can be incorporated into Arbor itself. -The Arbor documentation has a [Contributing section](https://arbor.readthedocs.io/en/latest/contrib) where we have laid out how you +The Arbor documentation has a [Contributing section](https://docs.arbor-sim.org/en/latest/contrib) where we have laid out how you can go about making your contribution. ## Get in touch diff --git a/README.md b/README.md index eb0437df779a8229325809932036a6363b15632f..f69290f6943c6e9c7aa3ccd0b3e68220e7216ca5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ [](https://gitlab.com/cscs-ci/arbor-sim/arbor/-/commits/master) -[](https://github.com/arbor-sim/arbor/actions?query=workflow%3A%22Basic+Tests+and+Documentation%22) +[](https://github.com/arbor-sim/arbor/actions/workflows/basic.yml) [](https://gitpod.io/#https://github.com/arbor-sim/arbor) -[](https://arbor.readthedocs.io/en/latest/) +[](https://docs.arbor-sim.org/en/latest/) # Arbor Library -Arbor is a library for implementing performance portable network simulations of multi-compartment neuron models. +[Arbor](https://arbor-sim.org) is a library for implementing performance portable network simulations of multi-compartment neuron models. An installation guide and library documentation are available online at [Read the Docs](http://arbor.readthedocs.io/en/latest/). @@ -13,4 +13,4 @@ An installation guide and library documentation are available online at [Read th ### Citing Arbor -Please refer to [our documentation](https://arbor.readthedocs.io/en/latest/index.html#citing-arbor). +Please refer to [our documentation](https://docs.arbor-sim.org/en/latest/index.html#citing-arbor). diff --git a/doc/contrib/doc.rst b/doc/contrib/doc.rst index 0dca60271ea239d350ef74f64ff20ee5ebc757c2..180162407e5cd5b7a20cd88de95aa766f7f0561b 100644 --- a/doc/contrib/doc.rst +++ b/doc/contrib/doc.rst @@ -3,7 +3,7 @@ Documentation ===================== -The source for `the documentation <https://arbor.readthedocs.io>`__ is +The source for `the documentation <https://docs.arbor-sim.org>`__ is found in the ``/doc`` subdirectory. You can add your contribution to the documentation in the same way you would contribute code, please see the :ref:`contribpr` section. diff --git a/doc/index.rst b/doc/index.rst index 6c113c149ed29d82e7de786d5ca09c5fe58c2d63..0ec4c89538ac2dcd2d176e623ab86b647388e723 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,8 +3,8 @@ Arbor |testbadge| |zlatest| -.. |testbadge| image:: https://github.com/arbor-sim/arbor/workflows/Basic%20Tests%20and%20Documentation/badge.svg - :target: https://github.com/arbor-sim/arbor/actions?query=workflow%3A%22Basic+Tests+and+Documentation%22 +.. |testbadge| image:: https://github.com/arbor-sim/arbor/actions/workflows/basic.yml/badge.svg + :target: https://github.com/arbor-sim/arbor/actions/workflows/basic.yml Welcome to the documentation for Arbor, the multi-compartment neural network simulation library. @@ -13,7 +13,7 @@ You can find out how to :ref:`get Arbor<in_install>`; get started quickly with o What is Arbor? -------------- -Arbor is a high-performance library for computational neuroscience simulations with multi-compartment, morphologically-detailed cells, +`Arbor <https://arbor-sim.org>`_. is a high-performance library for computational neuroscience simulations with multi-compartment, morphologically-detailed cells, from single cell models to very large networks. Arbor is written from the ground up with many-cpu and gpu architectures in mind, to help neuroscientists effectively use contemporary and future HPC systems to meet their simulation needs. diff --git a/python/morphology.cpp b/python/morphology.cpp index 24ffeb0235d3dbbed10759a395a251c319a07a77..7493fc886a1e3342f77ab27560f8b02a19084ce5 100644 --- a/python/morphology.cpp +++ b/python/morphology.cpp @@ -285,7 +285,7 @@ void register_morphology(py::module& m) { }, "filename"_a, "Generate a morphology from an SWC file following the rules prescribed by NEURON.\n" - "See the documentation https://arbor.readthedocs.io/en/latest/fileformat/swc.html\n" + "See the documentation https://docs.arbor-sim.org/en/latest/fileformat/swc.html\n" "for a detailed description of the interpretation."); // arb::morphology diff --git a/python/readme.md b/python/readme.md index 33d43a2f47fd8afd96d2f1e3b216192c1938057d..cfa7ddda1db778e878041d40f0045a67ece675e4 100644 --- a/python/readme.md +++ b/python/readme.md @@ -4,7 +4,7 @@ The Arbor Python package is a wrapper around the high-performance C++ library Ar constructing and running simulations multi-compartment neuron models, from single cell models to large networks. -Documentation is available online at [Read the Docs](https://arbor.readthedocs.io/en/latest/python). +Documentation is available online at [Read the Docs](https://docs.arbor-sim.org/en/latest/python). [Submit a ticket](https://github.com/arbor-sim/arbor) if you have any questions or want help. diff --git a/python/setup.py b/python/setup.py index 0b182d7dd4801782cde79e6684c3762d1033faad..70b4386a87e206547d3c67bb28bb7f0381a91267 100644 --- a/python/setup.py +++ b/python/setup.py @@ -25,7 +25,7 @@ setuptools.setup( ], project_urls={ 'Source': 'https://github.com/arbor-sim/arbor', - 'Documentation': 'https://arbor.readthedocs.io', + 'Documentation': 'https://docs.arbor-sim.org', 'Bug Reports': 'https://github.com/arbor-sim/arbor/issues', }, package_data={ diff --git a/setup.py b/setup.py index ac92bf81513d9190e5f41277a52dc4ae5ea05a50..8f8f70450210d11db5247a96f1895c724f49e651 100644 --- a/setup.py +++ b/setup.py @@ -233,7 +233,7 @@ setuptools.setup( ], project_urls={ 'Source': 'https://github.com/arbor-sim/arbor', - 'Documentation': 'https://arbor.readthedocs.io', + 'Documentation': 'https://docs.arbor-sim.org', 'Bug Reports': 'https://github.com/arbor-sim/arbor/issues', }, ) diff --git a/spack/package.py b/spack/package.py index 40de84304f337796f755eca7c125b9f690d67882..43019fa6f8c36a33c4d8adf7c491c5b246a88556 100644 --- a/spack/package.py +++ b/spack/package.py @@ -10,7 +10,7 @@ class Arbor(CMakePackage, CudaPackage): """Arbor is a high-performance library for computational neuroscience simulations.""" - homepage = 'https://arbor-sim.github.io/' + homepage = 'https://arbor-sim.org' git = 'https://github.com/arbor-sim/arbor.git' url = 'https://github.com/arbor-sim/arbor/releases/download/v0.5/arbor-v0.5-full.tar.gz' maintainers = ['bcumming', 'brenthuisman', 'haampie', 'halfflat'] @@ -25,7 +25,7 @@ class Arbor(CMakePackage, CudaPackage): variant('python', default=True, description='Enable Python frontend support') variant('vectorize', default=False, description='Enable vectorization of computational kernels') - # https://arbor.readthedocs.io/en/latest/install/build_install.html?highlight=requirements#compilers + # https://docs.arbor-sim.org/en/latest/install/build_install.html?highlight=requirements#compilers conflicts('%gcc@:8.3') conflicts('%clang@:7') # Cray compiler v9.2 and later is Clang-based.