Welcome to Manuscript Review’s documentation!

Manuscript Review System is designed to assist SCIENCE WRITERS COMMITTEE which aims at helping Emory researchers improve their manuscripts, learn from different research areas and gain more experience of reviewing others’ paper.

Contents

Installation Instruction

Pre-requested programs

  • This system is written in python / Django.
  • Please download python and install.
  • Please install pip, a tool for installing and managing Python packages

In Unix

  • Install virtual environment:

    pip install virtualenv
    
  • Start virtual environment:

    virtualenv prenv; source prenv/bin/activate
    
  • Install requirements:

    cd PeerReview; pip install -r requirements.txt
    

In Windows

  • Install virtual environment:

    pip install virtualenv
    
  • Start virtual environment:

    virtualenv prenv; prenv\Scripts\activate;
    
  • Install requirements: cd PeerReview:

    pip install -r requirements.txt;
    

Deployment Instruction

Adding the App

  • Create your Django app:

    django-admin.py startproject myproj; cd myproj;
    
  • Make sure it works:

    ./manage.py runserver
    
  • Clone the latest PeerReviewApp:

    git clone 'https://github.com/bkbolte181/PeerReviewApp.git'
    
  • Update the settings file using the parameters in sample-settings.py

  • Test to make sure everything works:

    ./manage.py test
    

On-line Help for admin

Login/Logout

  • Only one admin account is available for committee members to log in.
  • If you need the admin account as well as the password, please contact us
  • For current version of this system, to log in as a normal user, user needs to log out from the admin pages, if s/he has logged in as admin.

Manuscripts/Reviewers

  • The matching decision of Manuscripts/Reviewers will be made by the admin when the “Submit final decision” button was pressed and confirmed.
  • After the final decision was made, there is no way to edit it any more.
  • Manuscripts with pending matching decisions are listed above all manuscripts whose final descisions have been submitted.
  • Removing one current assigned reviewer can be done by unchecking the name after click on the button “Edit”.
  • The button “Add more reviewers” allows admin adding names which are listed neither in the list of assiged reviewers nor the list of recommend reviewers.
  • To add extra reviewers, click on “Edit” and then “Add more reviewers”; in the right panel, choose the names without a preceeding tick, and click the “<” button.

System setting

  • All the deadlines of current session can be modified in the page of “System Settings”.
  • The max number of manuscripts can also be modified in the same page.

On-line Help for normal users

Register

  • Only EMORY email address is allowed for register.
  • All fields in the register page need to be filled.
  • Review count means how many manuscripts you have reviewed for journals.

Login/Logout

  • The system only allows registered users, please make sure you have registered.
  • If you forget your email address or password, please contact us.
  • User’s email address is shown at the bottom of all the webpages after the user has logged in.

Term of Service Form

  • click the link above “Agreed to form” to view the form.
  • Only after agreeing with the term of service, user can submit or review manuscripts.

Manuscript submission

  • Submission will be disabled after the submission deadline or the pool of manuscripts are full.
  • To submit a manuscript, please enter the author center by clicking “submit” on the top right of the homepage for submission.

Manuscript list scanning

  • All submitted manuscripts can be viewed in review center.
  • Check the check box to show your interest to the corresponding manuscript. However, please be aware of that the assigned manuscript might be a different one.

Manuscript adoption

  • Once a manuscript is assigned, the reviewer can adopt it in the page “My Assigned Manuscripts” located in reviewer center.
  • An empty review form is available to download in reviewer center.

Review-form submission

  • Download the empty review form and complete it before the review deadline.

Deadlines

  • Manuscript submission should be done before the submission deadline.
  • Manuscript review should be done before the review deadline.

Function list

Functions delivered in version 1.0 (2014/12)

  • Admin
    1. Log in as admin
    2. Browse reviewer and manuscript list
    3. Edit and save the assignments of the manuscripts to reviewers
    4. Submit final decisions of reviewer selections
  • Normal User
    1. Create normal user account using Emory email adress.
    2. Log in as normal user.
    3. Edit own profile.
    4. Submit manuscripts.
    5. Save and edit a partially completed submission.
    6. Browse the list of submitted manuscripts.

Functions designed and planned for future

  • Admin
    1. Set up deadlines
    2. Set up and send email reminders
    3. Set up authors-reviewers meeting
    4. Set up the limitation number of manuscripts
    5. Request feedbacks from authors
  • Normal User
    1. Email address validation through numbers generated by the system
    2. Manuscript adoption
    3. Review form submission
    4. Review form management

Codes of Manuscript Review

admin module

custom_fields module

forms module

models module

tests module

urls module

views module

Testing

Integration_tests module

System_tests module

Unit_tests module

Indices and tables