Skip to content

Commit

Permalink
Add python skeleton, remove detritus (#1)
Browse files Browse the repository at this point in the history
* clean

* pre-commmit clean

* no java or julia here
  • Loading branch information
afmagee42 authored Nov 22, 2024
1 parent 5407bfe commit 559cfd1
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 156 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/scientific-improvement.md

This file was deleted.

15 changes: 0 additions & 15 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,6 @@ repos:
- id: style-files
- id: lintr
#####
# Java
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
rev: v2.11.0
hooks:
- id: pretty-format-java
args: [--aosp,--autofix]
#####
# Julia
# Due to lack of first-class Julia support, this needs Julia local install
# and JuliaFormatter.jl installed in the library
# - repo: https://github.com/domluna/JuliaFormatter.jl
# rev: v1.0.39
# hooks:
# - id: julia-formatter
#####
# Secrets
- repo: https://github.com/Yelp/detect-secrets
rev: v1.4.0
Expand Down
111 changes: 45 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,107 +1,86 @@
# cfa-repo-template
A template for new CFA repos
# Next generation matrix widget

⚠️ This is a work in progress

## How to use this template
To open a new repo using this template, click the green `Use this template`
button above and to the right. Then select `Create a new repository`.
Boilerplate language from [CDCgov GitHub Oroganization Open Source Project Template](https://github.com/cdcgov/template)
below the horizontal rule should be maintained in the final `README.md` file.

[Guidance about when clearance is needed and how to get it]

## This template contains
- [x] An Apache 2.0 license
- [ ] Issue templates for bugs, feature requests, and scientific improvements
- [ ] A pull request (PR) template
- [x] CI for linting and styling, following CFA's style guide for R, Python, and Java
- [x] A .gitignore template that covers R, Python, and Java

## Reminders on CFA collaborative programming practice

* CFA Predict [style guide](https://github.com/cdcent/cfa-predict-documentation/blob/main/docs/style_guide.md)
* CFA [GitHub workflow](https://github.com/cdcent/cfa-predict-documentation/blob/main/docs/github.md) for
* CFA Predict [code review guidance](https://github.com/cdcent/cfa-predict-documentation/blob/main/docs/code_review.md)

## Contributing to the CDCgov repo template

Please refer to [CDC's Template Repository](https://github.com/CDCgov/template)
for more information about [contributing to that repository](https://github.com/CDCgov/template/blob/master/CONTRIBUTING.md),
[public domain notices and disclaimers](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md),
and [code of conduct](https://github.com/CDCgov/template/blob/master/code-of-conduct.md).

## Contributing to this repo

Open an issue or PR and:

- For decisions that affect the template as a whole, but don't impact the content of other repos: consult the template owner, currently Eric Rescorla `@ekr-cfa`
- For decisions that affect specific languages, consult the repo language owner:
- Python: Dina Mistry
- Rust: Kate Hudson
- R: TBD
- All other languages: TBD
- For global policies, use the Predict [decision-making process](https://github.com/cdcent/cfa-predict-documentation/blob/main/docs/divisionwide_decisions.md)

------------------------------------------------------------------------------------
# Your project name

## Overview

Describe the purpose of your project. Add additional sections as necessary to help collaborators and potential collaborators understand and use your project.
This repo contains code for investigating the potential efficacy of
vaccination allocation for a disease interactively via a
[streamlit](https://streamlit.io/) app using a next generation matrix
approach.

## Project Admin
## Authors

Name, Degrees, e-mail, CDC org (e.g., CDC/IOD/ORR/CFA)
- Paige Miller <[email protected]>
- Scott Olesen <[email protected]>
- Andy Magee <[email protected]>

## General Disclaimer
This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/organization/mission.htm). GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

This repository was created for use by CDC programs to collaborate on public
health related projects in support of the
[CDC mission](https://www.cdc.gov/about/organization/mission.htm). GitHub is not
hosted by the CDC, but is a third party website used by CDC and its partners to
share information and collaborate on software. CDC use of GitHub does not imply
an endorsement of any one particular service, product, or enterprise.

## Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not
subject to domestic copyright protection under 17 USC § 105. This repository is in
the public domain within the United States, and copyright and related rights in
the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
All contributions to this repository will be released under the CC0 dedication. By
submitting a pull request you are agreeing to comply with this waiver of
subject to domestic copyright protection under 17 USC § 105. This repository is
in the public domain within the United States, and copyright and related rights
in the work worldwide are waived through the
[CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
All contributions to this repository will be released under the CC0 dedication.
By submitting a pull request you are agreeing to comply with this waiver of
copyright interest.

## License Standard Notice

This repository is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under
the terms of the Apache Software License version 2, or (at your option) any
later version.
This source code in this repository is free: you can redistribute it and/or
modify it under the terms of the Apache Software License version 2, or (at your
option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the Apache Software License for more details.
This source code in this repository is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software
License for more details.

You should have received a copy of the Apache Software License along with this
program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

## Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and
information. All material and community participation is covered by the
[Disclaimer](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md)
and [Code of Conduct](https://github.com/CDCgov/template/blob/master/code-of-conduct.md).
For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).
[Disclaimer](https://github.com/CDCgov/template/blob/master/DISCLAIMER.md) and
[Code of Conduct](https://github.com/CDCgov/template/blob/master/code-of-conduct.md).
For more information about CDC's privacy policy, please visit
[http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).

## Contributing Standard Notice
Anyone is encouraged to contribute to the repository by [forking](https://help.github.com/articles/fork-a-repo)
and submitting a pull request. (If you are new to GitHub, you might start with a

Anyone is encouraged to contribute to the repository by
[forking](https://help.github.com/articles/fork-a-repo) and submitting a pull
request. (If you are new to GitHub, you might start with a
[basic tutorial](https://help.github.com/articles/set-up-git).) By contributing
to this project, you grant a world-wide, royalty-free, perpetual, irrevocable,
non-exclusive, transferable license to all users under the terms of the
[Apache Software License v2](http://www.apache.org/licenses/LICENSE-2.0.html) or
later.

All comments, messages, pull requests, and other submissions received through
CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at [http://www.cdc.gov/other/privacy.html](http://www.cdc.gov/other/privacy.html).
CDC including this GitHub page may be subject to applicable federal law,
including but not limited to the Federal Records Act, and may be archived. Learn
more at
[http://www.cdc.gov/other/privacy.html](http://www.cdc.gov/other/privacy.html).

## Records Management Standard Notice

This repository is not a source of government records but is a copy to increase
collaboration and collaborative potential. All government records will be
published through the [CDC web site](http://www.cdc.gov).
Empty file added ngm/__init__.py
Empty file.
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[tool.poetry]
name = "ngm"
version = "0.1.0"
description = ""
authors = ["Paige Miller <[email protected]>", "Scott Olesen <[email protected]>", "Andy Magee <[email protected]>"]
readme = "README.md"

[tool.poetry.dependencies]
python = "^3.10"


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
Empty file added tests/__init__.py
Empty file.

0 comments on commit 559cfd1

Please sign in to comment.