Skip to content

Commit 1dd3812

Browse files
committed
updating the using replication guide
1 parent 7ce6dd7 commit 1dd3812

File tree

1 file changed

+5
-38
lines changed

1 file changed

+5
-38
lines changed

docs/replications.md

+5-38
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,15 @@ documentation](https://github.com/boalang/study-template).
1717

1818
You need a GNU Make compatible build system. Tested on GNU Make 3.81.
1919

20+
You will also need Python to run the analyses. See the [Python
21+
requirements](requirements.md#python-requirements) for more information.
22+
2023
Note that the Boa jobs themselves are marked public, so you do not need a Boa
2124
user to view the actual jobs/output via the website. However, the Boa API
2225
requires a user/password to use it, so programmatically downloading (even
2326
public jobs) currently requires authenticating. You can, however, manually
2427
download each of the query outputs from the public URLs.
2528

26-
### Python Requirements
27-
28-
Python 3 is required for all scripts. Tested on Python **TODO: put Python
29-
version used here**.
30-
31-
See `requirements.txt` for the package requirements. To install them, run:
32-
33-
```sh linenums="0"
34-
pip3 install -r requirements.txt
35-
```
36-
37-
There are also optional packages you can install to improve your experience.
38-
39-
#### Optional Python Requirements
40-
41-
If you install `tqdm>=4.64.0`, some scripts will display a progress bar. This
42-
can be very useful when processing extremely large (multi-GB) output files.
43-
44-
If you install `keyring>=23.8.2`, you can store your Boa API credentials in
45-
your OS's keyring. This is more secure than storing it in plaintext in the
46-
`.env` file. If you don't utilize either of those options, it will prompt you
47-
for your username/password (once for **each** output it tries to download!).
4829

4930
------------------------------------------------------
5031

@@ -62,22 +43,8 @@ make run-docker
6243

6344
## File Organization
6445

65-
Here is an overview of the folders layout. The root contains scripts for
66-
generating tables/figures for the paper, a `Makefile` for running scripts, and
67-
this `README.md` file.
68-
69-
### Subdir: `boa`
70-
These are the Boa queries used to generate data for the paper.
71-
72-
### Subdir: `data`
73-
This is the output of the Boa queries (the `.txt`) files, as well as processed
74-
versions of that output (`.csv` and `.parquet`).
75-
76-
### Subdir: `figures`
77-
Any generated figures (`.pdf`) will go into this folder.
78-
79-
### Subdir: `tables`
80-
Any generated tables (`.tex`) will go into this folder.
46+
The organization of a replication package is the same as in the original study.
47+
See the page on [Paths](research/paths.md) for more information.
8148

8249
------------------------------------------------------
8350

0 commit comments

Comments
 (0)