Skip to content
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

Badge for readme #4

Merged
merged 2 commits into from
Nov 24, 2023
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This is an optional package built to be used via [Redback](https://redback.readt
This package contains the data and methods to build/call surrogate models for EM transients using machine learning built on grids of numerical simulations.
If your aim is to just evaluate the models you could use this package independently but if you wish to simulate realistic transients or perform inference with these models, use [Redback](https://redback.readthedocs.io/en/latest/)

[![Documentation Status](https://readthedocs.org/projects/redback_surrogates/badge/?version=latest)](https://redback_surrogates.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/redback-surrogates/badge/?version=latest)](https://redback-surrogates.readthedocs.io/en/latest/?badge=latest)
![Python package](https://github.com/nikhil-sarin/redback_surrogates/workflows/Python%20application/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/nikhil-sarin/redback_surrogates/badge.svg?branch=main)](https://coveralls.io/github/nikhil-sarin/redback_surrogates?branch=main)
![PyPI](https://img.shields.io/pypi/v/redback_surrogates)
Expand Down
4 changes: 1 addition & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
#
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

sys.path.insert(0, os.path.abspath('../redback_surrogates/'))

# -- Project information -----------------------------------------------------

Expand All @@ -24,7 +23,6 @@
# The full version, including alpha/beta/rc tags
release = 'alpha'
autosummary_generate = True
autodoc_mock_imports = ["pickle", "scipy", "kilonovanet"]

source_suffix = ['.rst', '.md', '.txt', '.ipynb', '.py']
# -- General configuration ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ API:

.. autosummary::
:toctree: api
:template: custom-module-template.rst
:caption: API:
:recursive:

utils
kilonovamodels
afterglowmodels
supernovamodels
kilonovamodels
supernovamodels
Loading