Giter Club home page Giter Club logo

my-code-base's Introduction

My Code Base

build License MIT license

This is a collection of routines that I've developed over time and that I use in my daily work.

Installation

Clone this repo via

git clone https://github.com/markusritschel/my-code-base

Then, in the new directory (cd my-code-base/) install the package via:

pip install .

or via

pip install -e .

if you plan on making changes to the code.

Alternatively, install directly from GitHub via

pip install 'git+https://github.com/markusritschel/my-code-base.git'

Testing

Run make tests in the source directory to test the code. This will execute both the unit tests and docstring examples (using pytest).

Run make lint to check code style consistency.

Maintainer

Contact & Issues

For any questions or issues, please contact me via [email protected] or open an issue.


© Markus Ritschel 2024

my-code-base's People

Contributors

markusritschel avatar

Watchers

James Cloos avatar  avatar

my-code-base's Issues

Create usage examples

The documentation should include examples of how to use various features of the package.
For example:

  • How to deal with artifacts when plotting contour lines on stereographic plots (e.g. sea-ice concentration)
  • How to do seasonal decomposition of time series data
  • How to use the different accessors (xarray, polar plots, etc.)

Provide a decorator or masked *save* function

Provide a decorator for plt.savefig that feeds values to the metadata argument. For example:

  • the current git commit hash
  • the script producing the plot, plus the line of the function or the plt.savefig statement
  • version of the code/project

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.