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.

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

add file hashes to doc #170

Merged
merged 4 commits into from
May 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions docs/source/input_data/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,67 @@ follow these steps:
#. Fill out the information on the access request form to tell us about your project. You can simply put "Data access request" in the title field.
#. We will get back to you after we receive your request!

Validating pseudopeople input data
----------------------------------

The following table provides the SHA-256 checksum for the larger-scale input
data zip files:

.. list-table:: SHA-256 checksums
:header-rows: 1

* - Location
- File
- SHA-256 checksum
* - US
- pseudopeople_input_data_usa_1_0_0.zip
- 9462cc60b333fb2a3d16554a9e59b5428a81a2b1d2c34ed383883d7b68d2f89f
* - Rhode Island
- pseudopeople_input_data_ri_1_0_0.zip
- d3f1ccdfbfca8b53254c4ceeb18afe17c3d3b3fe02f56cc20d1254f818c39435

These checksums can be used to validate that you've successfully
downloaded the correct and uncorrupted zip file; if the SHA-256 checksum that
you generate for the downloaded file matches the value provided above, you can
be sure you downloaded the file successfully.

Possibly the simplest way to verify checksums is to generate the value using the
terminal/cmd command below (be sure to replace `PATH/TO/ZIP` with the actual path
to the zip you downloaded) and visually compare the result to the
values provided above. Note that if even the first few and last few characters
match then it is very likely the entire string matches.

Linux:

.. code-block:: console

$ sha256sum PATH/TO/ZIP

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't on my Mac. I have shasum -a 256 PATH/TO/ZIP

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird, my mac has both. Ok, will update

Mac:

.. code-block:: console

$ shasum -a 256 PATH/TO/ZIP

Windows:

.. code-block:: console

$ CertUtil -hashfile PATH/TO/ZIP SHA256

.. note::

Generating the checksum can take a long time for larger files, e.g. several
minutes for the Rhode Island dataset and ~1 hour for the United States dataset.

If the generated checksum does not match the one provided in the table above,
please try re-downloading the dataset.

If after downloading the file a second time the checksums still do not match,
please open a `Bug report <https://github.com/ihmeuw/pseudopeople/issues/new?assignees=&labels=&template=bug_report.yml>`_
using the template under the `Issues tab <https://github.com/ihmeuw/pseudopeople/issues>`_
on pseudopeople's GitHub page.

Using pseudopeople input data
-----------------------------

Expand Down