8000 Docs by pcubillos · Pull Request #8 · AtmoLib/chemcat · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

python:
install:
- requirements: requirements.txt
- requirements: docs/docs_requirements.txt
- method: pip
path: .
11 changes: 0 additions & 11 deletions .readthedocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion chemcat/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

__all__ = [
Expand Down
2 changes: 1 addition & 1 deletion chemcat/cea/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

from .cea import *
Expand Down
2 changes: 1 addition & 1 deletion chemcat/cea/cea.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

__all__ = [
Expand Down
2 changes: 1 addition & 1 deletion chemcat/janaf/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

from .janaf import *
Expand Down
2 changes: 1 addition & 1 deletion chemcat/janaf/janaf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

__all__ = [
Expand Down
2 changes: 1 addition & 1 deletion chemcat/network.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

__all__ = [
Expand Down
2 changes: 1 addition & 1 deletion chemcat/utils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

from .utils import *
Expand Down
2 changes: 1 addition & 1 deletion chemcat/utils/utils.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
D54 # Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

__all__ = [
Expand Down
4 changes: 2 additions & 2 deletions chemcat/version.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

# chemcat version:
__version__ = '0.3.6'
__version__ = '0.3.7'

2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
]
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
1 change: 1 addition & 0 deletions docs/docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sphinx-rtd-theme>=2.0.0
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Be Kind
=======

Please cite this paper if you found ``chemcat`` useful for your research:
`Cubillos, Blecic, et al. (2022): Radiative and Thermochemical Equilibrium Calculations and Application for Warm-Jupiter Exoplanets. <http://ui.adsabs.harvard.edu/abs/2022journ.000....0C>`_.
`Cubillos, Blecic, et al. (2024): Radiative and Thermochemical Equilibrium Calculations and Application for Warm-Jupiter Exoplanets. <http://ui.adsabs.harvard.edu/abs/2022journ.000....0C>`_

We welcome your feedback or inquiries, please refer them to:

Expand Down
2 changes: 1 addition & 1 deletion docs/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ License
=======

**chemcat**: Chemistry Calculator for Atmospheres, |br|
Copyright (C) 2022-2023 Jasmina Blecic and Patricio Cubillos
Copyright (C) 2022-2024 Jasmina Blecic and Patricio Cubillos

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ requires = [
'setuptools>=40.8.0',
'wheel',
'oldest-supported-numpy',
]

]
build-backend = "setuptools.build_meta"
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import os
Expand Down
2 changes: 1 addition & 1 deletion src_c/_thermo.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2022-2023 Blecic and Cubillos
// Copyright (c) 2022-2024 Blecic and Cubillos
// chemcat is open-source software under the GPL-2.0 license (see LICENSE)

#include <Python.h>
Expand Down
2 changes: 1 addition & 1 deletion src_c/_utils.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//# Copyright (c) 2022-2023 Blecic and Cubillos
//# Copyright (c) 2022-2024 Blecic and Cubillos
// chemcat is open-source software under the GPL-2.0 license (see LICENSE)

#include <Python.h>
Expand Down
2 changes: 1 addition & 1 deletion src_c/include/ind.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2022-2023 Blecic and Cubillos
// Copyright (c) 2022-2024 Blecic and Cubillos
// chemcat is open-source software under the GPL-2.0 license (see LICENSE)

// Definitions for indexing Numpy arrays:
Expand Down
2 changes: 1 addition & 1 deletion src_c/include/newton_raphson.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2022-2023 Blecic and Cubillos
// Copyright (c) 2022-2024 Blecic and Cubillos
// chemcat is open-source software under the GPL-2.0 license (see LICENSE)

void usrfun(
Expand Down
2 changes: 1 addition & 1 deletion tests/conftest.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion tests/test_cea.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion tests/test_janaf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import numpy as np
Expand Down
2 changes: 1 addition & 1 deletion tests/test_network.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import os
Expand Down
2 changes: 1 addition & 1 deletion tests/test_utils.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2022-2023 Blecic and Cubillos
# Copyright (c) 2022-2024 Blecic and Cubillos
# chemcat is open-source software under the GPL-2.0 license (see LICENSE)

import os
Expand Down
0