Policy Simulation Library Catalog Criteria #143
Comments
|
NONCONFIDENTIAL // EXTERNAL
Thank you Jason! Can you please give us an example of a citation — do you mean a paper describing what’s in the repository?
…---
Sent from Workspace ONE Boxer<https://whatisworkspaceone.com/boxer>
On June 6, 2021 at 3:58:47 PM EDT, Jason DeBacker ***@***.***> wrote:
NONCONFIDENTIAL // EXTERNAL
PLEASE NOTE: This email is not from a Federal Reserve address.
Do not click on suspicious links. Do not give out personal or bank information to unknown senders.
This issue outlines how the DSGE.jl model satisfies the criteria<https://pslmodels.org/Catalog/library_criteria.html> for inclusion in the PSL catalog<https://pslmodels.org/Catalog/index.html>.
Once all "MUST" items are checked off, a PR will be opened to include a PSL_catalog.json configuration file in this repository.
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).
* BSD 3-Clause license<https://github.com/FRBNY-DSGE/DSGE.jl/blob/main/LICENSE>
* Data MUST be publicly available, unless release is restricted by a third party.
* FRED API Key available upon request
* For any data that SHOULD not be disclosed, provided MUST be:
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;
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.
* All data seem available
* Projects MUST have unit tests and SHOULD report code coverage.
* Many unit tests, code coverage is reported.
* 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 the DSGE.jl/test/models/* directories for cached results from various model specifications.
* Projects MUST report names and contact information for at least one maintainer.
* Yes in Acknowledgements<https://frbny-dsge.github.io/DSGE.jl/latest/#Acknowledgments-1>
* Projects MUST have a suggested citation.
* 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.
* Mirrored at https://github.com/PSLmodels/DSGE.jl
* Projects MUST use a consistent versioning scheme, which SHOULD be semantic versioning.
* See releases<https://github.com/PSLmodels/DSGE.jl/releases>
Community Criteria
* Projects SHOULD have a public roadmap.
* Projects SHOULD have contributor documentation and guidelines.
* Contributor guide here<https://frbny-dsge.github.io/DSGE.jl/latest/contributing/>
* Projects SHOULD have regular office hours, webinars, or standing meetings.
* Projects SHOULD list technical contributors.
* See Acknowledgements<https://frbny-dsge.github.io/DSGE.jl/latest/#Acknowledgments-1>
* Projects SHOULD list funders.
* Clear that model supported by FRBNY
* Projects SHOULD list user citations and case studies.
* Projects SHOULD include subject matter tags, choosing from ...
* See "About" section on main page for GitHub repo
* Projects SHOULD include a disclaimer.
* See README
* Projects SHOULD have a public issues tracker.
* Projects SHOULD have a changelog.
* With releases<https://github.com/FRBNY-DSGE/DSGE.jl/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.
* Projects MAY include a list of consultants.
Interoperability Criteria
* The source code SHOULD be written in an open source language.
* Julia
* 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<https://github.com/PSLmodels/PSL-Infrastructure/tree/master/Tools/Catalog-Builder>.
Please respond if there are criteria that I have missed.
If a maintainer of this model would be available to join the PSL Leadership Council meeting at 3pm ET on June 15 (call in information available at the PSL events page<https://pslmodels.org/events.html>), the Council would appreciate their participation. We will be discussing the inclusion of this model in the PSL catalog at that time and it would be useful to have a back and forth with any questions (from all parties). Thanks!
cc @MarcoDelNegro<https://github.com/MarcoDelNegro> @chenwilliam77<https://github.com/chenwilliam77> @alissarjohnson<https://github.com/alissarjohnson> @ShlokG<https://github.com/ShlokG> @Peter-Metz<https://github.com/Peter-Metz>
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#143>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADG4QIVZLM36ZE6VLDFWYFDTRPHO3ANCNFSM46GKEK2A>.
This e-mail message, including attachments, is for the sole use of the intended recipient(s) and may contain confidential or proprietary information. If you are not the intended recipient, immediately contact the sender by reply e-mail and destroy all copies of the original message.
|
|
@MarcoDelNegro Good question. Let me clarify -- the PSL Criteria is asking to see some suggested citation format for users of the model. E.g., The Tax-Calculator model suggests:
The FRBNY-DSGE model may have something like this already - I just wasn't able to find it in the documentation. Feel free to point me to it if I missed something. |
|
NONCONFIDENTIAL // EXTERNAL
Hi Jason,
We’ve added a suggested citation to the README and uploaded the PSL catalog.
From: Jason DeBacker ***@***.***>
Sent: Sunday, June 6, 2021 10:28 PM
To: FRBNY-DSGE/DSGE.jl ***@***.***>
Cc: Subscribed ***@***.***>
Subject: [External] Re: [FRBNY-DSGE/DSGE.jl] Policy Simulation Library Catalog Criteria (#143)
NONCONFIDENTIAL // EXTERNAL
PLEASE NOTE: This email is not from a Federal Reserve address.
Do not click on suspicious links. Do not give out personal or bank information to unknown senders.
@MarcoDelNegro<https://github.com/MarcoDelNegro> Good question. Let me clarify -- the PSL Criteria is asking to see some suggested citation format for users of the model.
E.g., The Tax-Calculator model suggests<http://taxcalc.pslmodels.org/#citing-tax-calculator>:
Please cite the source of your analysis as “Tax-Calculator release #.#.#, author’s calculations”. If you wish to provide a link to Tax-Calculator, the preferred URL is: https://PSLmodels.github.io/Tax-Calculator. Additionally, we strongly recommend that you describe the input data used, and provide a link to the materials required to replicate your analysis or, at least, note that those materials are available upon request.
The FRBNY-DSGE model may have something like this already - I just wasn't able to find it in the documentation. Feel free to point me to it if I missed something.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub<#143 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADC6CYHCRNBEBLJNW6C64HTTRQVDXANCNFSM46GKEK2A>.
This e-mail message, including attachments, is for the sole use of the intended recipient(s) and may contain confidential or proprietary information. If you are not the intended recipient, immediately contact the sender by reply e-mail and destroy all copies of the original message.
|
|
Excellent! All required PSL criteria a met -- thanks for setting a great example of open and transparent code for analyzing economic policy! |
|
Thank you to @alissarjohnson and @ShlokG for attending the PSL Leadership Council meeting! The DSGE.jl model has been accepted as a cataloged project: https://pslmodels.org/Catalog/index.html |
|
NONCONFIDENTIAL // EXTERNAL
Yes, I am glad Alissa and Shlok were able to make it. And thank you for the great news!
…---
Sent from Workspace ONE Boxer<https://whatisworkspaceone.com/boxer>
On June 17, 2021 at 1:07:53 PM EDT, Jason DeBacker ***@***.***> wrote:
NONCONFIDENTIAL // EXTERNAL
PLEASE NOTE: This email is not from a Federal Reserve address.
Do not click on suspicious links. Do not give out personal or bank information to unknown senders.
Thank you to @alissarjohnson<https://github.com/alissarjohnson> and @ShlokG<https://github.com/ShlokG> for attending the PSL Leadership Council meeting!
The DSGE.jl model has been accepted as a cataloged project: https://pslmodels.org/Catalog/index.html
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#143 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ADG4QIR7JSTOAQEF2KXHOSDTTITTPANCNFSM46GKEK2A>.
This e-mail message, including attachments, is for the sole use of the intended recipient(s) and may contain confidential or proprietary information. If you are not the intended recipient, immediately contact the sender by reply e-mail and destroy all copies of the original message.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This issue outlines how the DSGE.jl model satisfies the criteria for inclusion in the PSL catalog.
Once all "MUST" items are checked off, a PR will be opened to include a
PSL_catalog.jsonconfiguration file in this repository.Acceptance Criteria for Transparency and Quality
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;
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.
DSGE.jl/test/models/*directories for cached results from various model specifications.Community Criteria
Interoperability Criteria
PSL_catalog.jsonconfiguration 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.Please respond if there are criteria that I have missed.
If a maintainer of this model would be available to join the PSL Leadership Council meeting at 3pm ET on June 15 (call in information available at the PSL events page), the Council would appreciate their participation. We will be discussing the inclusion of this model in the PSL catalog at that time and it would be useful to have a back and forth with any questions (from all parties). Thanks!
cc @MarcoDelNegro @chenwilliam77 @alissarjohnson @ShlokG @Peter-Metz
The text was updated successfully, but these errors were encountered: