Data

Tools

Indexes

Applications

Experiments

Open Source Science

physicstools

A library of objects and functions for physics

https://github.com/will-roscoe/physicstools

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary

Keywords from Contributors

mesh sequences interactive hacking
Last synced: 7 months ago · JSON representation ·

Repository

A library of objects and functions for physics

Basic Info
  • Host: GitHub
  • Owner: will-roscoe
  • License: agpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 7.26 MB
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Created over 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog Contributing Funding License Citation

README.md

Python Project Template

A low dependency and really simple to start project template for Python Projects.

See also - Flask-Project-Template for a full feature Flask project including database, API, admin interface, etc. - FastAPI-Project-Template The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands.

HOW TO USE THIS TEMPLATE

DO NOT FORK this is meant to be used from Use this template feature.

  1. Click on Use this template
  2. Give a name to your project
    (e.g. my_awesome_project recommendation is to use all lowercase and underscores separation for repo names.)
  3. Wait until the first run of CI finishes
    (Github Actions will process the template and commit to your new repo)
  4. If you want codecov Reports and Automatic Release to PyPI
    On the new repository settings->secrets add your PYPI_API_TOKEN and CODECOV_TOKEN (get the tokens on respective websites)
  5. Read the file CONTRIBUTING.md
  6. Then clone your new project and happy coding!

NOTE: WAIT until first CI run on github actions before cloning your new project.

What is included on this template?

  • 🖼️ Templates for starting multiple application types:
    • Basic low dependency Python program (default) use this template
    • Flask with database, admin interface, restapi and authentication use this template. or Run make init after cloning to generate a new project based on a template.
  • 📦 A basic setup.py file to provide installation, packaging and distribution for your project.
    Template uses setuptools because it's the de-facto standard for Python packages, you can run make switch-to-poetry later if you want.
  • 🤖 A Makefile with the most useful commands to install, test, lint, format and release your project.
  • 📃 Documentation structure using mkdocs
  • 💬 Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release.
  • 🐋 A simple Containerfile to build a container image for your project.
    Containerfile is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
  • 🧪 Testing structure using pytest
  • ✅ Code linting using flake8
  • 📊 Code coverage reports using codecov
  • 🛳️ Automatic release to PyPI using twine and github actions.
  • 🎯 Entry points to execute your program using python -m <physicstools> or $ physicstools with basic CLI argument parsing.
  • 🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.

Curious about architectural decisions on this template? read ABOUTTHISTEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.

❤️ Sponsor this project

physicstools

codecov CI

Awesome physicstools created by will-roscoe

Install it from PyPI

bash pip install physicstools

Usage

```py from physicstools import BaseClass from physicstools import base_function

BaseClass().basemethod() basefunction() ```

```bash $ python -m physicstools

or

$ physicstools ```

Development

Read the CONTRIBUTING.md file.

Owner

  • Name: Will Roscoe
  • Login: will-roscoe
  • Kind: user
  • Location: Lancaster, UK

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Noble Roscoe"
  given-names: "William Arthur"
  orcid: "https://orcid.org/0009-0004-3146-6548"
title: "physicstools"
version: 1.0.0
date-released: 2023-12-16
url: "https://github.com/will-roscoe/physicstools"

GitHub Events

Total
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 5
  • Pull request event: 1
  • Create event: 1
Last Year
  • Delete event: 1
  • Issue comment event: 2
  • Push event: 5
  • Pull request event: 1
  • Create event: 1

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 18
  • Total Committers: 3
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.222
Past Year
  • Commits: 18
  • Committers: 3
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.222
Top Committers
Name Email Commits
Will Roscoe w****e@l****k 14
will 1****e 3
dependabot[bot] 4****] 1
Committer Domains (Top 20 + Academic)
lancaster.ac.uk: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 8 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 5
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (6)
Top Labels
Issue Labels
Pull Request Labels
dependencies (6)

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v3 composite
.github/workflows/release.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • softprops/action-gh-release v1 composite
.github/workflows/rename_project.yml actions
  • actions/checkout v4 composite
  • stefanzweifel/git-auto-commit-action v5 composite
requirements-test.txt pypi
  • black * test
  • coverage * test
  • flake8 * test
  • gitchangelog * test
  • isort * test
  • mkdocs * test
  • mypy * test
  • pytest * test
  • pytest-cov * test
requirements.txt pypi
setup.py pypi