This is the repository for submitting to and managing the Proceedings for the Annual Scientific Computing with Python Conference.
This repository is a home for authors, reviewers and editors to collaboratively create the proceedings for the conference.
You can find more information about the proceedings' organising principles below.
All communication between authors and reviewers should be civil and respectful. There are no exceptions to this rule. Please see the NumFOCUS Code of Conduct for more info. Attendees at SciPy 2024 are subject to the NumFOCUS Code of Conduct.
You can find the schedule for 2024 below.
Please use @-mentions in issues and pull requests(PRs) to contact the proceedings Co-Chairs.
If you are an Author, please see Instructions for Authors.
If you are a Reviewer, please see Instructions for Reviewers.
If you are an Editor, please see Instructions for Editors.
If you are a Publisher, please see Instructions for Publishers.
If you are Submitting Slides, please see Instructions for Slides.
Overall, the SciPy proceedings are organised to be a fully open proceedings.
We aim to combine the best aspects of open source development, open peer review, and open access publication.
The technologies used for running the conference are themselves developed in the open and built on open source tools.
Open Development:
The systems for running the conference are built on top of open source tools, including:
The entire submission and review procedure occurs through public PRs attached to identifiable individuals.
Authors and reviewers are encouraged to work collaboratively to improve submissions throughout the review process, much like open source code-review.
Reviews are collaborative, aiming to improve the publication quality. This is possible because the content was already vetted by the program committee.
Conversations occur attached to people's real GitHub usernames and are open to the public.
The papers are published as true Open Access (OA) articles with Creative Commons Attribution (CC-BY-4.0) license.
There are no article processing charges barring authors from submitting papers.
Papers are openly available at http://proceedings.scipy.org, with no pay walls barring consumption or author processing charges.
From 2010 onward, papers have DOIs (making them easily citable) and are also openly available from those DOIs.
From 2023 onwards, full HTML is the preferred format in addition to the PDF being available.
The community is involved in the entire process for creating the proceedings, which ensures relevance to the community that created them.
Papers are submitted by authors who will be presenting talks and posters at the annual SciPy conference. Because we know the content is relevant to the SciPy community, review can focus on improving papers, not vetting them.
Reviewers are invited by the editors, but community members may volunteer to review papers that interest them. The only barrier to participation is having a GitHub account.
The most effective way to contact the Proceedings Co-Chairs for issues related to this GitHub repository is to use GitHub's issues and "@"-mentioning the Co-Chairs.
In 2024, the Proceedings Co-Chairs are:
In addition to the following list, we break up the deadlines in the respective documents for authors and reviewers.
Please submit your papers by 23:59 PST of the Deadline to submit first draft.
Submit your papers as a MyST Markdown (mystmd.org) or
LaTeX file via PR against this repository.
Please only use LaTeX if you are already familiar with writing papers in LaTeX.
The build process are using the mystmd
CLI in 2024, which allows us to support
a web-first reading experience.
In future years this will allow us to accept notebooks and computational
environments, however, this is not available in 2024.
During the Open Review Period authors should work with their reviewers to refine and improve their submission.
Proceedings Co-Chairs have final say in determining whether a paper is to be accepted to the proceedings.
Authors should respond to all the reviewers' comments.
Authors should default to modifying their papers in response to reviewers' comments.
Authors may not agree with the reviewers comments or may not wish to implement the suggested changes. In those cases, the authors and reviewers should attempt to discuss this in the PR's comment sections. It is important to remember in these cases that we expect all communication between authors and reviewers to be civil and respectful.
In the event that authors and reviewers are deadlocked, they should alert the Proceedings Co-Chairs to this situation. As always, the Proceedings Co-Chairs have final say in whether to accept or reject a paper.
An excellent webinar entitled "SciPy Proceedings 2024: Quickstart and authoring tutorial" is available on YouTube.
If you have a challenge with any technical aspect of authoring your paper in MyST or LaTeX, please do not hesitate to reach out via your GitHub pull request or issue on this repository. A member of the Proceedings Co-chairs will help you directly or identify a work-around.
myst start
), the PDF is built upon acceptance onlypapers/00_myst_template
and papers/00_tex_template
paper
to trigger the build process. If you do not add this, a proceedings chair member will add it for you.mybib.bib
.myst.yml
(docs)including figures but not including references; this is about 8 pages for the published PDF that will be created upon acceptance.
Below we outline the steps to submit a paper.
Before you begin, you should have a GitHub account. If we refer to <username>
in code examples, you should replace that with your GitHub username.
More generally, angle brackets with a value inside are meant to be replaced with the value that applies to you.
For example, if you typically clone using the web URL, and your GitHub username was mpacer
, you would transform
git clone <scheme>github.com/<username>/scipy_proceedings.git
into:
git clone https://github.com/mpacer/scipy_proceedings
[!NOTE] There is a webinar on YouTube that goes through the author submission process for 2024 submissions using MyST Markdown.
scipy_proceedings
repo.scipy_proceedings
repo.2024
branch.
scipy_proceedings
repo, do not include it in your
submission's PR, create a separate PR against dev
(see below for more details).<scheme>
with git@
or https://
, for example<username>
with your GitHub usernamegit clone <scheme>github.com/<username>/scipy_proceedings.git
cd scipy_proceedings/
scipy-conference
repository as your upstream
remote
git remote add upstream <scheme>github.com/scipy-conference/scipy_proceedings
If you run git remote -v
you should see something like the following:
origin <scheme>github.com/<username>/scipy_proceedings.git (fetch)
origin <scheme>github.com/<username>/scipy_proceedings.git (push)
upstream <scheme>github.com/scipy-conference/scipy_proceedings.git (fetch)
upstream <scheme>github.com/scipy-conference/scipy_proceedings.git (push)
scipy_proceedings
repo
git fetch upstream
2024
branch
git checkout -b 2024 --track upstream/2024
If you are submitting only one paper, you can use the 2024
branch directly.
Otherwise, you will need to create a new branch based on 2024
and set its
upstream to origin.
git checkout 2024
git checkout -b <your_branch_name>
git push --set-upstream origin <your_branch_name>
pyenv
or conda
).pip install mystmd
nodejs
(see options)papers/<your_directory_name>
<firstname_surname>
papers/00_myst_template
or papers/00_tex_template
id
in the myst.yml
to by scipy-2024-<your_directory_name>
cd papers/<your_directory_name>
myst start
and open the web-server providedmyst.yml
Note: The templates are setup for a single MyST/LaTeX file in the top level of <your_directory_name>
. If you have more than one file run myst init --write-toc
(docs), ensuring that the root
is the main file of your manuscript.
papers/<your_directory_name>
If you want to alter other parts of the scipy_proceedings
repo, we use a separate
submission procedure (see below).
Your paper will be edited and reviewed in HTML, the PDF will only be built on acceptance.
To preview your paper:
mystmd
is installed (guide)papers/<your_directory_name>
run myst start
Once you are ready to submit your paper, make a pull request on GitHub. Please ensure that you file against the correct branch.
2024
branchPaper:
. Note: for the first commit in your PR, an editor will add the paper
label, which will start the GitHub actions.Creating build system PRs is deprecated in 2024. Curvenote is the build system now.
If you want to change documentation, etc., we use a separate submission procedure.
dev
dev
branch, it will be reviewed separatelyWhen you push to your repositories branch it automatically run GitHub actions on the PR. Note that this will require authorization for your first commit only. The build process takes about a minute, and then posts or updates a comment on the PR with a link to the build result on Curvenote. The build page has a link to your preview.
The review process will be completed on the HTML, and you can check to see if the paper(s) that you preview locally match the paper(s) that you see online. These will be available in a GitHub comment or through the logs in the GitHub action.
If it is not the same, please immediately contact us with a GitHub issue describing the discrepancy. Please include screenshots and an explanation of the differences. For best results, please @-mention the Proceedings Co-Chairs.
We are interested in working towards full support for publishing computational notebooks as part of the proceedings, and are trialing this part of the submission process for interested authors - please get in touch with the Proceedings Co-Chairs with your interest.
You will be reviewing authors' pull requests. While authors should have a proper draft of their paper ready for you by the Deadline to submit first draft.
We ask that you read this set of suggested review criteria before beginning any reviews.
All communication between authors and reviewers should be civil and respectful at all times.
The goal of our review process is to improve the paper that the authors are working on. Our aim is to have you and the author collaborate on making their better by using an iterative process.
While our basic approach is to have you and the author iterate, we ask you to complete an initial review and start that conversation by the Initial Complete Review deadline.
We ask that by the Final Reviewer Decision deadline you have a recommendation to either accept or reject the paper at that point and time.
Note: You many recommend changes after the Final Reviewer Decision deadline. If there are any major changes after the Final Reviewer Decision deadline you should immediately contact the Proceedings Committee Co-Chairs. As a heuristic, if you think the paper should not be in the proceedings unless the authors make the change in question, then that change should be requested and made before the Final Reviewer Decision deadline.
A small subcommittee of the SciPy 2017 organizing committee has created this set of suggested review criteria to help guide authors and reviewers alike. Suggestions and amendments to these review criteria are enthusiastically welcomed via discussion or pull request.
mystmd
) and NodeJS (>18)The build process is completed through GitHub actions on every commit. A comment is posted after the build process completes with a list of checks and a link to the built output on Curvenote.
Authors: you should check to ensure that your local builds match the papers built online. Please create an issue if they do not match.
Reviewers: You should be able to see the built article from the GitHub comment, and review from the preview link.
To information about how to manage the whole proceedings, please see
publisher/README.md
and publisher/Makefile
.
As reviewers review papers, editors should apply labels to the PR to flag the
current state of the review process. All paper PRs must have the paper
label before the GitHub action will be triggered. Additionally, as editors and reviewers are assigned, the editors should add the reviewers GitHub handles to the PR summary comment.
Other labels that should be used are:
Editors should come to a final 'ready', 'unready' decision before the Final Editorial Decisions for Proceedings Contents deadline.
scipy_proceedings
repo.scipy_proceedings
repo.2024
branch.presentations
folder, there are directories for:
info.json
with the following fields needed for uploading to Zenodo (using an empty string for author orcid or
affiliation if these cannot be provided):{
"title": "The title of your presentation",
"authors": [
{
"name": "The first author or presenter",
"affiliation": "first author's affiliation",
"orcid": "0000-0000-0000-0000"
},
{
"name": "The second author or presenter",
"affiliation": "second author's affiliation",
"orcid": "0000-0000-0000-0001"
}
],
"description": "1-4 sentences explaining what your presentation is about"
}
You can see examples of submissions in the example
folder in each presentation directory.