submissions¶
Models¶
-
class
submissions.models.
EICRecommendation
(*args, **kwargs)[source]¶ The EICRecommendation is the recommendation of a Submission written by the Editor-in-charge made at the end of the refereeing cycle. It can be voted for by a subset of Fellows and should contain the actual publication decision.
-
class
submissions.models.
EditorialAssignment
(*args, **kwargs)[source]¶ EditorialAssignment is a registration for Fellows of their duties of being a Editor-in-charge for a specific Submission. This model could start as a invitation only, which should then be accepted or declined by the invited.
-
class
submissions.models.
EditorialCommunication
(*args, **kwargs)[source]¶ Each individual communication between Editor-in-charge to and from Referees and Authors becomes an instance of this class.
-
class
submissions.models.
RefereeInvitation
(id, submission, referee, title, first_name, last_name, email_address, invitation_key, date_invited, invited_by, nr_reminders, date_last_reminded, accepted, date_responded, refusal_reason, fulfilled, cancelled)[source]¶
-
class
submissions.models.
Report
(*args, **kwargs)[source]¶ Both types of reports, invited or contributed.
This Report model acts as both a regular Report and a FollowupReport; A normal Report should have all fields required, whereas a FollowupReport only has the report field as a required field.
Important note! Due to the construction of the two different types within a single model, it is important to explicitly implement the perticular differences in for example the form used.
-
associated_published_doi
¶ Check if the Report relates to a SciPost-published object. If it is, return the doi of the published object.
-
is_followup_report
¶ Check if current Report is a FollowupReport. A Report is a FollowupReport if the author of the report already has a vetted report in the series of the specific Submission.
-
latest_report_from_series
()[source]¶ Get latest Report from the same author for the Submission series.
-
relation_to_published
¶ Check if the Report relates to a SciPost-published object. If it is, return a dict with info on relation to the published object, based on Crossref’s peer review content type.
-
title
¶ This property is (mainly) used to let Comments get the title of the Submission without annoying logic.
-
-
class
submissions.models.
Submission
(*args, **kwargs)[source]¶ Submission is a SciPost register of an ArXiv article. This object is the central instance for every action, recommendation, communication, etc. etc. that is related to the refereeing cycle of a Submission. A possible Publication object is later directly related to this Submission instance.
-
comments_set_complete
()[source]¶ Return comments to Submission, comments on Reports of Submission and nested comments related to this Submission.
-
other_versions
¶ Return all other versions of the Submission that are publicly accessible.
-
other_versions_pool
¶ Return all other versions of the Submission.
-
thread
¶ Return all versions of the Submission with that arxiv id.
-
-
class
submissions.models.
SubmissionEvent
(*args, **kwargs)[source]¶ The SubmissionEvent’s goal is to act as a messaging/logging model for the Submission cycle. Its main audience will be the author(s) and the Editor-in-charge of a Submission.
Be aware! Both the author and editor-in-charge will read the submission event. Make sure the right text is given to the right event-type, to protect the fellow’s identity.
Views¶
-
submissions.views.
accept_or_decline_ref_invitations
(request, invitation_id=None)[source]¶ RefereeInvitations need to be either accepted or declined by the invited user using this view. The decision will be taken one invitation at a time.
-
submissions.views.
add_remark
(request, arxiv_identifier_w_vn_nr)[source]¶ With this method, an Editorial Fellow or Board Member is adding a remark on a Submission.
-
submissions.views.
assign_submission
(request, arxiv_identifier_w_vn_nr)[source]¶ Assign Editor-in-charge to Submission. Action done by SciPost Administration or Editorial College Administration.
-
submissions.views.
assignment_failed
(request, arxiv_identifier_w_vn_nr)[source]¶ No Editorial Fellow has accepted or volunteered to become Editor-in-charge. The submission is rejected. This method is called from pool.html by an Editorial Administrator.
-
submissions.views.
assignment_request
(request, assignment_id)[source]¶ Process EditorialAssignment acceptance/denial form or show if not submitted.
-
submissions.views.
assignments
(request)[source]¶ This page provides a Fellow with an explicit task list of editorial actions which should be undertaken.
-
submissions.views.
cancel_ref_invitation
(request, arxiv_identifier_w_vn_nr, invitation_id)[source]¶ This method is used by the Editor-in-charge from the editorial_page to remove a referee for the list of invited ones. It can be used for registered as well as unregistered referees.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
close_refereeing_round
(request, arxiv_identifier_w_vn_nr)[source]¶ Called by the Editor-in-charge when a satisfactory number of reports have been gathered. Automatically emails the authors to ask them if they want to round off any replies to reports or comments before the editorial recommendation is formulated.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
communication
(request, arxiv_identifier_w_vn_nr, comtype, referee_id=None)[source]¶ Communication between editor-in-charge, author or referee occurring during the submission refereeing.
-
submissions.views.
cycle_form_submit
(request, arxiv_identifier_w_vn_nr)[source]¶ If Submission is resubmission_incoming the EIC should first choose what refereeing cycle to choose.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
editorial_page
(request, arxiv_identifier_w_vn_nr)[source]¶ The central page for the EIC to manage all its Editorial duties.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
editorial_workflow
(request)[source]¶ Summary page for Editorial Fellows, containing a digest of the actions to take to handle Submissions.
-
submissions.views.
eic_recommendation
(request, arxiv_identifier_w_vn_nr)[source]¶ Write EIC Recommendation.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
extend_refereeing_deadline
(request, arxiv_identifier_w_vn_nr, days)[source]¶ Extend Refereeing deadline for Submission and open reporting and commenting.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
fix_College_decision
(request, rec_id)[source]¶ Terminates the voting on a Recommendation. Called by an Editorial Administrator.
# TODO - 2 bugs:
TO FIX: If multiple recommendations are submitted; decisions may be overruled unexpectedly. TO FIX: A college decision can be fixed multiple times, there is no already-fixed mechanism!!!
-
submissions.views.
pool
(request, arxiv_identifier_w_vn_nr=None)[source]¶ The Submissions pool contains all submissions which are undergoing the editorial process, from submission to publication acceptance or rejection. All members of the Editorial College have access.
-
submissions.views.
recruit_referee
(request, arxiv_identifier_w_vn_nr)[source]¶ If the Editor-in-charge does not find the desired referee among Contributors (otherwise, the method send_refereeing_invitation below is used instead), he/she can invite somebody by providing name + contact details. This function emails a registration invitation to this person. The pending refereeing invitation is then recognized upon registration, using the invitation token.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
ref_invitation_reminder
(request, arxiv_identifier_w_vn_nr, invitation_id)[source]¶ This method is used by the Editor-in-charge from the editorial_page when a referee has been invited but hasn’t answered yet. It can be used for registered as well as unregistered referees.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
reformulate_eic_recommendation
(request, arxiv_identifier_w_vn_nr)[source]¶ Reformulate EIC Recommendation.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
remind_Fellows_to_vote
(request)[source]¶ This method sends an email to all Fellow with pending voting duties. It must be called by and Editorial Administrator.
TODO: This reminder function doesn’t filter per submission?!
-
submissions.views.
report_detail_pdf
(request, arxiv_identifier_w_vn_nr, report_nr)[source]¶ Download the PDF of a Report if available.
-
submissions.views.
reports_accepted_list
(request)[source]¶ This view lists all accepted Reports. This shows if Report needs a PDF update/compile in a convenient way.
-
submissions.views.
select_referee
(request, arxiv_identifier_w_vn_nr)[source]¶ Select/Invite referees by first listing them here.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
send_refereeing_invitation
(request, arxiv_identifier_w_vn_nr, contributor_id)[source]¶ This method is called by the EIC from the submission’s editorial_page, in the case where the referee is an identified Contributor. For a referee who isn’t a Contributor yet, the method recruit_referee above is called instead.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
set_refereeing_deadline
(request, arxiv_identifier_w_vn_nr)[source]¶ Set Refereeing deadline for Submission and open reporting and commenting if the new date is in the future.
Accessible for: Editor-in-charge and Editorial Administration
-
submissions.views.
submission_refereeing_package_pdf
(request, arxiv_identifier_w_vn_nr)[source]¶ This view let’s the user download all Report PDF’s in a single merged PDF. The merging takes places every time its downloaded to make sure all available report PDF’s are included and the EdColAdmin doesn’t have to compile the package every time again.
-
submissions.views.
submit_report
(request, arxiv_identifier_w_vn_nr)[source]¶ A form to submit a report on a submission will be shown and processed here.
Important checks to be aware of include an author check for the submission, has the reporting deadline not been reached yet and does there exist any invitation for the current user on this submission.
-
submissions.views.
treated_submissions_list
(request)[source]¶ This view lists all accepted Reports. This shows if Report needs a PDF update/compile in a convenient way.
-
submissions.views.
vet_submitted_report
(request, report_id)[source]¶ Report with status unvetted will be shown. A user may only vet reports of submissions he/she is EIC of or if he/she is SciPost Admin or Vetting Editor.
After vetting an email is sent to the report author, bcc EIC. If report has not been refused, the submission author is also mailed.