diff options
| author | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2019-10-01 16:17:59 +0100 |
|---|---|---|
| committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2019-10-01 16:23:39 +0100 |
| commit | 7caa2845304c40540a336f840b3ca468bf6c8697 (patch) | |
| tree | 2ee7942a848f6880e5e2f9c2252e365bc20b7e65 /README.md | |
| parent | 6f86ba0c1f84b9c349666254c2a9716ba2058a3b (diff) | |
Preparation phase added before final building
In many real-world scenarios, `./project make' can really benefit from
having some basic information about the data before being run. For example
when quering a server. If we know how many datasets were downloaded and
their general properties, it can greatly optmize the process when we are
designing the solution to be run in `./project make'.
Therefore with this commit, a new phase has been added to the template's
design: `./project prepare'. In the raw template this is empty, because the
simple analysis done in the template doesn't warrant it. But everything is
ready for projects using the template to add preparation phases prior to
the analysis.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 18 insertions, 5 deletions
@@ -21,6 +21,7 @@ received this source from arXiv, please see the respective section below. $ git clone XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX $ cd XXXXXXXXXXXXXXXXXX $ ./project configure +$ ./project prepare $ ./project make ``` @@ -76,11 +77,23 @@ requiring root/administrator permissions. $ ./project configure ``` -3. Run the following command (local build of the Make software) to - reproduce all the analysis and build the final `paper.pdf` on `8` - threads. If your CPU has a different number of threads, change the - number (you can see the number of threads available to your operating - system by running `./.local/bin/nproc`) +3. In some cases, the project's analysis may need some preparations to + optimize its processing. This is usually mainly related to input data, + and some very basic calculations that can help the management of the + overall lproject in the main/next step. To do the basic preparations, + please run this command to do the preparation on `8` threads. If your + CPU has a different number of threads, change the number (you can see + the number of threads available to your operating system by running + `./.local/bin/nproc`) + + ```shell + $ ./project prepare -j8 + ``` + +4. Run the following command to reproduce all the analysis and build the + final `paper.pdf` on `8` threads. If your CPU has a different number of + threads, change the number (you can see the number of threads available + to your operating system by running `./.local/bin/nproc`) ```shell $ ./project make -j8 |