Skip to content

Commit

Permalink
Updated DOI, citation and pypi upload link.
Browse files Browse the repository at this point in the history
  • Loading branch information
cylammarco committed Apr 25, 2023
1 parent e4be114 commit 90ff5e2
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cibuild-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ jobs:
with:
user: ${{ secrets.pypi_username }}
password: ${{ secrets.pypi_password }}
repository_url: https://test.pypi.org/legacy/
repository_url: https://upload.pypi.org/legacy/
22 changes: 22 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
cff-version: 1.2.0
title: spectresc
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Marco C
family-names: Lam
email: lam@mail.tau.ac.il
affiliation: Tel Aviv University
orcid: 'https://orcid.org/0000-0002-9347-2298'
identifiers:
- type: doi
value: 10.5281/zenodo.7863171
description: Zenodo
- type: article
value: "arXiv:1705.05165"
description: The ArXiv preprint of the article
repository-code: 'https://github.com/cylammarco/spectresc'
url: 'https://pypi.org/project/spectresc/'
license: GPL-3.0-or-later
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
[![Readthedocs Status](https://readthedocs.org/projects/spectres/badge/?version=latest&style=flat)](https://spectres.readthedocs.io)
[![arXiv](https://img.shields.io/badge/arXiv-1705.05165-00ff00.svg)](https://arxiv.org/abs/1705.05165)
[![PyPI version](https://badge.fury.io/py/spectresc.svg)](https://badge.fury.io/py/spectresc)
[![DOI](https://zenodo.org/badge/DOI/.svg)](https://doi.org/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7863171.svg)](https://doi.org/10.5281/zenodo.7863171)

This is a Python package written with C extension to provide significant performance gain on [SpectRes](https://github.com/ACCarnall/SpectRes), and some performance over the numba implementation:

![alt text](https://github.com/cylammarco/SpectResC/blob/main/speed_test/speed_test.png?raw=true)

We keep the implementation as close to SpectRes as possible. As of SpectRes v2.2.0, we do not see discrepant results between using SpectRes and SpectReC.

## Installation

SpectResC can be installed using pip
Expand All @@ -26,4 +28,4 @@ Please refer to the original SpectRes for the [documentation](https://spectres.r
If you have made use of SpectResC, please reference:

1. the original SpectRes [arXiv article](https://arxiv.org/abs/1705.05165)
2. the [zenodo DOI](...) for SpectResC
2. the [zenodo DOI](https://zenodo.org/record/7863171) for SpectResC

0 comments on commit 90ff5e2

Please sign in to comment.