Data

Tools

Indexes

Applications

Experiments

Open Source Science

TulipaIO

https://github.com/tulipaenergy/tulipaio.jl

Science Score: 44.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
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary

Keywords from Contributors

energy-systems interpretability battery hack matrix-exponential meshing state-management pde modelling-tool milp
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: TulipaEnergy
  • License: apache-2.0
  • Language: Julia
  • Default Branch: main
  • Size: 1.13 MB
Statistics
  • Stars: 1
  • Watchers: 5
  • Forks: 6
  • Open Issues: 19
  • Releases: 9
Created about 2 years ago · Last pushed 8 months ago
Metadata Files
Readme License Code of conduct Citation

README.dev.md

Developer documentation

You can find more general developer documentation at TulipaEnergyModel's README.dev.md. Here you will find more specific information.

Notes on writing tests

Testing for exceptions and errors

We should also test error handling, this is particularly important since TulipaIO is user-facing. We follow two principles:

  1. throw a relevant Exception, if one doesn't exist, we can create one that emits a relevant message; see exceptions.jl and its uses in the codebase.

  2. to test an exception, we test both the exception type, and the generated message. This is done with @test_throws. While testing the type has been supported in Julia 1.6 (LTS), unfortunately testing the message has only been supported since Julia 1.8, also the test has to be done by repeating the error. So the guideline is to test exceptions like this example from test-pipeline.jl:

julia @test_throws DimensionMismatch TIO.set_tbl_col(args...; opts...) if (VERSION.major >= 1) && (VERSION.minor >= 8) @test_throws [r"Length.+different", r"index.+value"] TIO.set_tbl_col(args...; opts...) end

Owner

  • Name: Tulipa
  • Login: TulipaEnergy
  • Kind: organization
  • Location: Netherlands

Electricity Market and Sector-Coupling Modelling Tools from TNO

Citation (CITATION.cff) 

# Go to https://citation-file-format.github.io/cff-initializer-javascript/#/ to finish this
cff-version: 1.2.0
title: TulipaIO.jl
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Suvayu Ali
    email: fatkasuvayu+linux@gmail.com

GitHub Events

Total
  • Create event: 26
  • Commit comment event: 14
  • Release event: 6
  • Issues event: 9
  • Watch event: 1
  • Delete event: 17
  • Issue comment event: 54
  • Push event: 104
  • Pull request review event: 47
  • Pull request review comment event: 15
  • Pull request event: 53
  • Fork event: 2
Last Year
  • Create event: 26
  • Commit comment event: 14
  • Release event: 6
  • Issues event: 9
  • Watch event: 1
  • Delete event: 17
  • Issue comment event: 54
  • Push event: 104
  • Pull request review event: 47
  • Pull request review comment event: 15
  • Pull request event: 53
  • Fork event: 2

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 116
  • Total Committers: 10
  • Avg Commits per committer: 11.6
  • Development Distribution Score (DDS): 0.457
Past Year
  • Commits: 48
  • Committers: 8
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.688
Top Committers
Name Email Commits
Suvayu Ali f****x@g****m 63
Abel Soares Siqueira a****a@e****l 22
Diego Alejandro Tejada Arango 1****a 7
CompatHelper Julia c****y@j****g 6
github-actions[bot] 4****] 5
allcontributors[bot] 4****] 5
dependabot[bot] 4****] 3
Lauren Clisby l****y@g****m 3
Wester Coenraads 1****s 1
Dheepak Krishnamurthy 1****k 1
Committer Domains (Top 20 + Academic)
julialang.org: 1 esciencecenter.nl: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 8
  • Total pull requests: 43
  • Average time to close issues: 3 months
  • Average time to close pull requests: 17 days
  • Total issue authors: 4
  • Total pull request authors: 7
  • Average comments per issue: 3.38
  • Average comments per pull request: 0.95
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 12
Past Year
  • Issues: 3
  • Pull requests: 43
  • Average time to close issues: 5 days
  • Average time to close pull requests: 17 days
  • Issue authors: 2
  • Pull request authors: 7
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.95
  • Merged pull requests: 38
  • Bot issues: 0
  • Bot pull requests: 12
View more stats
Top Authors
Issue Authors
  • abelsiqueira (14)
  • clizbe (11)
  • suvayu (5)
  • datejada (4)
  • JuliaTagBot (1)
Pull Request Authors
  • github-actions[bot] (23)
  • abelsiqueira (22)
  • suvayu (15)
  • datejada (7)
  • dependabot[bot] (6)
  • clizbe (3)
  • kdheepak (2)
  • wcoenraads (2)
Top Labels
Issue Labels
Type: improvement (12) Zone: code architecture (8) Type: addition (3) Zone: documentation (2) Type: bug (2) Zone: testing (2) bug (1) good first issue (1) Zone: user functions (1) Zone: SQL backend (1) Zone: setup/admin (1) Zone: interop (1)
Pull Request Labels
chore (13) dependencies (6)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 7 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 9
juliahub.com: TulipaIO
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 7 Total
Rankings
Dependent repos count: 9.5%
Average: 23.9%
Dependent packages count: 38.3%
Last synced: 7 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia v1 composite
.github/workflows/Copier.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/setup-julia v1 composite
  • peter-evans/create-pull-request v5 composite
.github/workflows/Docs.yml actions
  • actions/checkout v2 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/Lint.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/Test.yml actions
  • actions/cache v1 composite
  • actions/checkout v3 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite