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.

Sign up for GitHub

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

Jump to bottom

DOC: How to construct config files #454

Merged
merged 79 commits into from
Jun 8, 2021
Merged

DOC: How to construct config files #454

merged 79 commits into from
Jun 8, 2021

Conversation

Lucia-Fonseca
Copy link
Member

@Lucia-Fonseca Lucia-Fonseca commented Mar 23, 2021 •
edited
Loading

Description

This PR adds a section to the documentation to outline how to construct configuration files, providing a walkthrough of this flow and how to think through the process of creating a general configuration file.
This PR partially addresses the review comments for the JOSS submission process.
Merge of this PR closes #444 linked to openjournals/joss-reviews#3056

Checklist

  • Follow the Contributor Guidelines
  • Write unit tests
  • Write documentation strings
  • Assign someone from your working team to review this pull request
  • Assign someone from the infrastructure team to review this pull request

@Lucia-Fonseca Lucia-Fonseca self-assigned this Mar 23, 2021
@Lucia-Fonseca Lucia-Fonseca marked this pull request as draft March 23, 2021 09:44
@Lucia-Fonseca Lucia-Fonseca added documentation Improvements or additions to documentation joss_paper labels Mar 23, 2021
@Lucia-Fonseca
Copy link
Member Author

Lucia-Fonseca commented Mar 23, 2021 •
edited
Loading

The walkthrough example is intended to be a dialog. If it doesn't look professional, I am happy to change it.

I need help with:

  • Table.init and table.complete dependencies`.
  • Rewording and rephrasing.

@Lucia-Fonseca Lucia-Fonseca requested a review from a team March 25, 2021 17:15
@ntessore
Copy link
Member

The walkthrough example is intended to be a dialog. If it doesn't look professional, I am happy to change it.

I think a normal step by step list of things to do would be much much better.

@Lucia-Fonseca Lucia-Fonseca marked this pull request as ready for review March 29, 2021 17:17
@Lucia-Fonseca Lucia-Fonseca requested review from a team and removed request for a team April 6, 2021 14:57
@ntessore
Copy link
Member

Minor point: Should the name of the file match the short title in the menu (configuration_files.html)?

@Lucia-Fonseca Lucia-Fonseca changed the title How to construct config files DOC:How to construct config files Apr 13, 2021
@Lucia-Fonseca
Copy link
Member Author

This is ready for the final review. I still struggle with the examples for .depends, .init and .complete.

rrjbca
rrjbca reviewed Jun 8, 2021
View reviewed changes
docs/configuration_files.rst Outdated Show resolved Hide resolved
rrjbca
rrjbca reviewed Jun 8, 2021
View reviewed changes
docs/configuration_files.rst Outdated Show resolved Hide resolved
rrjbca
rrjbca reviewed Jun 8, 2021
View reviewed changes
docs/configuration_files.rst Outdated Show resolved Hide resolved
rrjbca
rrjbca reviewed Jun 8, 2021
View reviewed changes
docs/configuration_files.rst Outdated Show resolved Hide resolved
@rrjbca rrjbca merged commit 101ad83 into skypyproject:main Jun 8, 2021
@rrjbca rrjbca mentioned this pull request Jun 30, 2021
Closed
40 tasks
itrharrison added a commit that referenced this pull request Dec 15, 2022
@itrharrison @rrjbca
@ntessore @Lucia-Fonseca @sutieng @philipp128 @Fox-Davidson
MAINT: merge main into module/halos (#581)
3496ac0 
* Update name of default branch to main (#434)

* update mailmap (#432)

* Write all tables to a single FITS/HDF5 file (#425)

* ADR 3: Position sampling and patches of the sky (#422)

* BUG: Raise ImportError if optional dependency speclite is not installed (#437)

* MAINT: Set NumPy latest supported version to 1.20 #440

* Update status badges (#441)

* MAINT: Update Lucia affiliation (#451)

* MAINT: add SIT's information (#450)

* DOC: Fix contributor guidelines link (#449)

Co-authored-by: Richard R <58728519+rrjbca@users.noreply.github.com>
Co-authored-by: Nicolas Tessore <n.tessore@ucl.ac.uk>

* ENH: Logging for skypy command line script and Pipeline class (#453)

* DOC: Describe speclite filters in documentation (#457)

* ENH: Config syntax for importing objects (#463)

* DOC: List of Features (#456)

* DOC: How to construct config files (#454)

* DOC: Remove docstring examples (#429)

* MAINT: Update Zenodo entry for RPR (#468)

* DOC: Readme updates (#460)

* DOC: Expanded landing page documentation (#228)

* DOC: Inverse transform sampling accuracy warning (#472)

* MAINT: Set astropy latest supported version to 4.2 (#483)

* DOC: zenodo json members update (#481)

* DOC: Ryden04 ellipticity doc missing section (#477)

* MAINT: Update numpy and scipy latest supported versions (#488)

* BUG: Change invalid ecsv datatype from int to uint16 (#485)

* DEV: setuptools==58.0.0 (#493)

Co-authored-by: Nicolas Tessore <n.tessore@ucl.ac.uk>

* Add compatibility workflow badge (#487)

* DEV: Enable pip to install pre-releases in the tox dev environments (#491)

* TST: Use tmp_path fixture for temporary files in unit tests (#489)

* BUG: Move handling of context arguments after handling of .depends keyword (#465)

* BLD: Set astropy latest supported version to 4.3 and speclite minversion to 0.14 (#486)

* REV: restore setuptools to latest version on readthedocs (#494)

* DEV: pyparsing<3.0.0 (#500)

* Check new astropy file overwrite error message in logging test (#498)

* REV: restore pyparsing to latest version for doc builds (#501)

* DOC: Update citation file with JOSS paper reference (#496)

* BLD: Set astropy latest supported version to 5.0 (#504)

* BLD: Set python latest supported version to 3.10 (#505)

* BLD: Set numpy latest supported version to 1.22 (#506)

* BLD: Set python oldest supported version to 3.7 (#507)

* DOC: Fix code of conduct link (#508)

* Changed y-label in luminosity function example. (#512)

* BLD: Set scipy latest supported version to 1.8 (#510)

* ENH: Rykoff model of the magnitude uncertainty (#526)

* TST: assert photometric error is numerically close to the analytic value (#545)

* TST: Drop deprecated astropy.tests.helper.raises (#546)

* ENH: compute kcorrect remaining stellar mass (#476)

* compute kcorrect remaining stellar mass

* added test for stellar mass remain

Co-authored-by: Ian Harrison <itrharrison@gmail.com>
Co-authored-by: Lucia F. de la Bella <55983939+Lucia-Fonseca@users.noreply.github.com>

* ENH: Logistic completeness function (#521)

* BLD: Set astropy latest supported version to 5.1 (#547)

* BUG: `schechter_smf` callable input and docs (#525)

* DOC: Typo in Rykoff error (#550)

* add Fox's details (#551)

Co-authored-by: Richard R <58728519+rrjbca@users.noreply.github.com>

* BLD: Set numpy latest supported version to 1.23 (#552)

* codestyle fixes

* add six requirement for colossus

* tried to fix docs builds

* update passenv

* rtd configuration

Co-authored-by: Richard R <58728519+rrjbca@users.noreply.github.com>
Co-authored-by: Nicolas Tessore <n.tessore@ucl.ac.uk>
Co-authored-by: Lucia F. de la Bella <55983939+Lucia-Fonseca@users.noreply.github.com>
Co-authored-by: Sut-Ieng Tam <30295725+sutieng@users.noreply.github.com>
Co-authored-by: philipp128 <48715661+philipp128@users.noreply.github.com>
Co-authored-by: Fox Davidson <93545862+Fox-Davidson@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laurawolz laurawolz laurawolz left review comments

@jucordero jucordero jucordero left review comments

@philipp128 philipp128 philipp128 approved these changes

@rrjbca rrjbca rrjbca approved these changes

Assignees

@Lucia-Fonseca Lucia-Fonseca

Labels
documentation Improvements or additions to documentation joss_paper
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Guide to Constructing Configuration Files - JOSS Review
6 participants
@Lucia-Fonseca @ntessore @laurawolz @jucordero @philipp128 @rrjbca