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

Apply for PSL #13

Closed
MaxGhenis opened this issue Apr 28, 2019 · 1 comment
Closed

Apply for PSL #13

MaxGhenis opened this issue Apr 28, 2019 · 1 comment

Comments

@MaxGhenis
Copy link
Collaborator

Requirements at https://github.com/PSLmodels/PSL/blob/master/Criteria/library_criteria.md

Separate issues for each requirement to come.

@MaxGhenis
Copy link
Collaborator Author

MaxGhenis commented Dec 17, 2019

Here are the criteria. I'll update this comment as I make progress.

Acceptance Criteria for Transparency and Quality

  • Models MUST be released under an OSI-approved open source license or the Creative Commons Public Domain Dedication (CC0). See LICENSE (MIT).
  • Data MUST be publicly available, unless release is restricted by a third party. Doesn't include data, except using Tax-Calculator's CPS file as a default.
  • For any data that SHOULD not be disclosed, provided MUST be: N/A
    - A complete descriptive list of all data variables;
    • Descriptive statistics for all data variables for such data (including averages, standard deviations, number of observations, and correlations to other variables), to the extent that the descriptive statistics do not violate the rule against disclosure;
    • Contact information for the individual or entity who has unrestricted access to the data.
  • A complete descriptive list of all data variables; N/A
  • Descriptive statistics for all data variables for such data (including averages, standard deviations, number of observations, and correlations to other variables), to the extent that the descriptive statistics do not violate the rule against disclosure; N/A
  • Contact information for the individual or entity who has unrestricted access to the data. N/A
  • Projects MUST have unit tests and SHOULD report code coverage. Reports code coverage (not yet 100%)
  • At least one test MUST generate key outputs from source materials, the test MUST be run with every new version, and the outputs of the test MUST be checked into the repository. See test_compare.py
  • Projects MUST report names and contact information for at least one maintainer. See README.
  • Projects MUST have a suggested citation. See README.
  • Projects MUST have a project overview. See README.
  • Projects MUST have installation directions. See README.
  • Project MUST be mirrored in the same GitHub organization as PSL, and therefore they MUST be under version control. See Transfer to PSLmodels organization #61.
  • Projects MUST use a consistent versioning scheme, which SHOULD be semantic versioning. If projects want to use the PSL Package-Builder tool to distribute packages via the Anaconda Cloud PSLmodels channel, there are additional MUST criteria. See Release via Package-Builder #65.

Community Criteria

  • Projects SHOULD have a public roadmap. See ROADMAP.md
  • Projects SHOULD have contributor documentation and guidelines. See Add contributor documentation and guidelines #67.
  • Projects SHOULD have regular office hours, webinars, or standing meetings.
  • Projects SHOULD list technical contributors. See README.
  • Projects SHOULD list funders. N/A
  • Projects SHOULD list user citations and case studies. See List user citations and case studies #68.
  • Projects SHOULD include subject matter tags, choosing from ... ****
  • Projects SHOULD include a disclaimer. See Add disclaimer #66.
  • Projects SHOULD have a public issues tracker. github.com/MaxGhenis/microdf/issues
  • Projects SHOULD have a changelog. github.com/MaxGhenis/microdf/releases.
  • Projects MAY have a Stack Overflow channel.
  • Projects MAY include a "News" translation of the changelog for users.
  • Projects MAY include criteria for participating in cross-model PSL initiatives.
  • Projects MAY include a link to a webapp version. N/A
  • Projects MAY include a list of consultants. N/A

Interoperability Criteria

  • The source code SHOULD be written in an open source language. Python.
  • A PSL_catalog.json configuration file to be used for cataloging these criteria MUST be included in the project's repository. Specific instructions for creating this file can be found in the Catalog-Builder Documentation. See Add PSL_catalog.json #64.

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

No branches or pull requests

1 participant