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

Create cython backend #1

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Create cython backend #1

wants to merge 26 commits into from

Conversation

MuellerSeb
Copy link
Member

@MuellerSeb MuellerSeb commented Jul 11, 2024

  • only keept cython files
  • added tests for cython routines
  • added doc strings
  • added coverage for cython files in CI

@MuellerSeb MuellerSeb marked this pull request as draft July 11, 2024 22:02
@MuellerSeb
Copy link
Member Author

@LSchueler ready for a first review.

@MuellerSeb MuellerSeb marked this pull request as ready for review July 13, 2024 22:54
@LSchueler
Copy link
Member

Awesome! I'll have a closer look into this next week, looking forward to it.

Copy link
Member

@LSchueler LSchueler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is going to make (development) life with GSTools much nicer :-)

A few things:

  • I think in the README.md you should make a comment that the user shouldn't be using this package directly. If you put this directly at the beginning, the rest of the document makes sense, with a short explanation of how to install the GSTools package rather than GSTools-Cython.

[![Documentation Status](https://readthedocs.org/projects/gstools/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/gstools/en/stable/?badge=stable)
[![Build Status](https://github.com/GeoStat-Framework/GSTools-Cython/workflows/Continuous%20Integration/badge.svg?branch=main)](https://github.com/GeoStat-Framework/GSTools-Cython/actions)
[![Coverage Status](https://coveralls.io/repos/github/GeoStat-Framework/GSTools-Cython/badge.svg?branch=main)](https://coveralls.io/github/GeoStat-Framework/GSTools-Cython?branch=main)
[![Documentation Status](https://readthedocs.org/projects/gstools-cython/badge/?version=latest)](https://geostat-framework.readthedocs.io/projects/gstools-cython/en/stable/?badge=stable)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we really need a readthedocs-site for GSTools-Core?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set it up and it is cool to have a documentation for the low level routines. So it is there, why should we remove it again?

.. |Twitter| image:: https://img.shields.io/twitter/follow/GSFramework?style=social
:alt: Twitter Follow
:target: https://twitter.com/GSFramework
.. mdinclude:: ../../README.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woah! What kind of black magic is this?!?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used this for the changelog for ages.

Purpose
=======

GeoStatTools is a library providing geostatistical tools
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just stumbled upon this. Has anyone ever used the name "GeoStatTools"? - Maybe we should start to only use "GSTools"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is true. It's a remainder of the old times.

src/gstools_cython/__init__.py Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants