Skip to content

Commit

Permalink
Merge pull request #168 from brian-rose/update-docs
Browse files Browse the repository at this point in the history
Update all references to source repo
  • Loading branch information
brian-rose committed May 24, 2022
2 parents 23c849a + 92fa62a commit 49d87ce
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 30 deletions.
25 changes: 13 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================
=======
climlab
================
=======

|docs| |JOSS| |DOI| |pypi| |Build Status| |coverage|

Expand All @@ -9,7 +9,7 @@ climlab
-----------------------------------------------------

Author
--------------
------
| **Brian E. J. Rose**
| Department of Atmospheric and Environmental Sciences
| University at Albany
Expand Down Expand Up @@ -84,8 +84,8 @@ Links
-----

- HTML documentation: http://climlab.readthedocs.io/en/latest/intro.html
- Issue tracker: http://github.com/brian-rose/climlab/issues
- Source code: http://github.com/brian-rose/climlab
- Issue tracker: http://github.com/climlab/climlab/issues
- Source code: http://github.com/climlab/climlab
- JOSS meta-paper: https://doi.org/10.21105/joss.00659


Expand Down Expand Up @@ -137,6 +137,8 @@ Version 0.8.0 (released May 2022)
Builds of these helper packages are available through conda-forge and will be
automatically installed as dependencies by conda / mamba.

The climlab source repo also moved to https://github.com/climlab/climlab

There should be no breaking changes to the user-facing API.

The major motivation for this change was to (vastly) simplify the development
Expand Down Expand Up @@ -243,7 +245,7 @@ Version 0.6.0 (released December 2017)
Provides full Python 3 compatibility, updated documentation, and minor enhancements and bug fixes.

Version 0.5.5 (released early April 2017)
Finally provides easy binary distrbution with conda_
Finally provides easy binary distribution with conda_

Version 0.5.2 (released late March 2017)
Many under-the-hood improvements to the build procedure,
Expand Down Expand Up @@ -302,8 +304,7 @@ The documentation_ was first created by Moritz Kreuzer
Contact and Bug Reports
-----------------------
Users are strongly encouraged to submit bug reports and feature requests on
github at
https://github.com/brian-rose/climlab
github at https://github.com/climlab/climlab


License
Expand All @@ -315,10 +316,10 @@ See the accompanying LICENSE file.
:target: https://doi.org/10.21105/joss.00659
.. |pypi| image:: https://badge.fury.io/py/climlab.svg
:target: https://badge.fury.io/py/climlab
.. |Build Status| image:: https://github.com/brian-rose/minimalf2py/actions/workflows/build-and-test.yaml/badge.svg
:target: https://github.com/brian-rose/climlab/actions/workflows/build-and-test.yml
.. |coverage| image:: https://codecov.io/github/brian-rose/climlab/coverage.svg?branch=main
:target: https://codecov.io/github/brian-rose/climlab?branch=main
.. |Build Status| image:: https://github.com/climlab/climlab/actions/workflows/build-and-test.yaml/badge.svg
:target: https://github.com/climlab/climlab/actions/workflows/build-and-test.yml
.. |coverage| image:: https://codecov.io/github/climlab/climlab/coverage.svg?branch=main
:target: https://codecov.io/github/climlab/climlab?branch=main
.. |DOI| image:: https://zenodo.org/badge/24968065.svg
:target: https://zenodo.org/badge/latestdoi/24968065
.. |docs| image:: http://readthedocs.org/projects/climlab/badge/?version=latest
Expand Down
4 changes: 2 additions & 2 deletions conda-recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ test:
- codecov

about:
home: https://github.com/brian-rose/climlab
home: https://github.com/climlab/climlab
license: MIT
license_family: MIT
license_file: LICENSE
summary: Python package for process-oriented climate modeling
doc_url: http://climlab.readthedocs.io/
dev_url: https://github.com/brian-rose/climlab
dev_url: https://github.com/climlab/climlab

extra:
recipe-maintainers:
Expand Down
4 changes: 2 additions & 2 deletions docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Authors
About
-----
Sphinx-based documentation for the `climlab` (https://github.com/brian-rose/climlab) package.
Sphinx-based documentation for the `climlab` (https://github.com/climlab/climlab) package.

The latest rendered version is always available online at `http://climlab.readthedocs.io`

Expand Down Expand Up @@ -60,4 +60,4 @@ focussing specifically on the EBM (energy balance model) code.

We are gradually expanding and updating the documentation to reflect the full capabilities of `climlab`.
It is a work-in-progress, and contributions to the documentation
as pull requests on `github <https://github.com/brian-rose/climlab>`_ are very welcome.
as pull requests on `github <https://github.com/climlab/climlab>`_ are very welcome.
2 changes: 1 addition & 1 deletion docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

{#
{% block footer %}
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">climlab Documentation</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Moritz Kreuzer</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/brian-rose/climlab" rel="dct:source">https://github.com/brian-rose/climlab</a>.
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">climlab Documentation</span> by <span xmlns:cc="http://creativecommons.org/ns#" property="cc:attributionName">Moritz Kreuzer</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/climlab/climlab" rel="dct:source">https://github.com/climlab/climlab</a>.
{% endblock %}
#}

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The lead developer and maintainer of `climlab` is
| brose@albany.edu
Community contributions are very welcome!
Bugs can be reported through the `issue tracker <https://github.com/brian-rose/climlab/issues>`_ on github.
Bugs can be reported through the `issue tracker <https://github.com/climlab/climlab/issues>`_ on github.


The documentation was originally created by **Moritz Kreuzer**, Potsdam Institut for Climate Impact Research (PIK).
Expand Down
12 changes: 6 additions & 6 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For publications, please cite the `CLIMLAB description paper in JOSS`_. The full
Reporting bugs, issues, new feature requests, and documentation problems
------------------------------------------------------------------------

These can all be raised as new issues at <https://github.com/brian-rose/climlab/issues>
These can all be raised as new issues at <https://github.com/climlab/climlab/issues>

If you are reporting a bug, try to include:

Expand All @@ -46,10 +46,10 @@ Although CLIMLAB is offered to the community "as-is", we are very interested in
helping people actually use it for scientific purposes.

Have a question about how to do something with CLIMLAB? First, make sure you've
perused the documentation_ and the issue tracker at <https://github.com/brian-rose/climlab/issues>.
perused the documentation_ and the issue tracker at <https://github.com/climlab/climlab/issues>.
Also look through published examples including the online book `The Climate Laboratory`_.

Then, feel free to ask questions by opening a new issue at <https://github.com/brian-rose/climlab/issues>.
Then, feel free to ask questions by opening a new issue at <https://github.com/climlab/climlab/issues>.
This requires a free github account but is the best way to engage the community for answers.
We will do our best to respond. If the functionality you're looking for doesn't
yet exist, we'll probably encourage you to get involved in developing the next big feature.
Expand All @@ -59,13 +59,13 @@ Contributing bug fixes and new features
---------------------------------------

We are thrilled to have any and all help.
You may want to browse through <https://github.com/brian-rose/climlab/issues>
You may want to browse through <https://github.com/climlab/climlab/issues>
to see if there is any low-hanging fruit already identified.

Contributions will happen through Pull Requests on github.
You will need a free github account. Here's how to get started:

1. Follow `these instructions`_ to fork the CLIMLAB repo at <https://github.com/brian-rose/climlab>,
1. Follow `these instructions`_ to fork the CLIMLAB repo at <https://github.com/climlab/climlab>,
clone it on your local machine, and keep your local main branch synced with the main repo.

2. Don't make any commits on your local main branch. Instead open a feature branch for every new development task::
Expand Down Expand Up @@ -212,7 +212,7 @@ and (optionally) delete the build environment with::
.. _`Contact page`: contact.html
.. _ReStructuredText: http://docutils.sourceforge.net/docs/user/rst/quickstart.html
.. _`these instructions`: https://help.github.com/articles/fork-a-repo/
.. _`open issue on the CLIMLAB github page`: https://github.com/brian-rose/climlab/issues/68
.. _`open issue on the CLIMLAB github page`: https://github.com/climlab/climlab/issues/68
.. _documentation: http://climlab.readthedocs.io
.. _`pull request`: https://help.github.com/articles/about-pull-requests/
.. _`numpy.f2py`: https://numpy.org/doc/stable/f2py/
Expand Down
7 changes: 3 additions & 4 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Installing from source

You can clone the source code repository with::

git clone https://github.com/brian-rose/climlab.git
git clone https://github.com/climlab/climlab.git

and from the ``climlab`` directory, do::

Expand Down Expand Up @@ -60,14 +60,13 @@ and use most of the package. You will see warning messages about the missing com
.. _`climlab-emanuel-convection`: https://github.com/climlab/climlab-emanuel-convection



Source Code
=============

Stables releases as well as the current development version can be found on github:

* `Stable Releases <https://github.com/brian-rose/climlab/releases>`_
* `Development Version <https://github.com/brian-rose/climlab>`_
* `Stable Releases <https://github.com/climlab/climlab/releases>`_
* `Development Version <https://github.com/climlab/climlab>`_


Dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For a more comprehensive set of climlab usage examples embedded within lecture n
see Brian's online textbook `The Climate Laboratory <https://brian-rose.github.io/ClimateLaboratoryBook/>`_.

If you want to run the code yourself, these notes are all available as Jupyter *.ipynb files
in the ``docs/source/courseware`` directory of the `climlab source <https://github.com/brian-rose/climlab>`_.
in the ``docs/source/courseware`` directory of the `climlab source <https://github.com/climlab/climlab>`_.
.. toctree::
:titlesonly:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def readme():
'Topic :: Scientific/Engineering :: Atmospheric Science',
],
keywords='climate modeling modelling model ebm radiation radiative-convective earth',
url='http://github.com/brian-rose/climlab',
url='http://github.com/climlab/climlab',
author='Brian E. J. Rose',
author_email='brose@albany.edu',
setup_requires=['numpy'],
Expand Down

0 comments on commit 49d87ce

Please sign in to comment.