Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrbajdek authored Jun 26, 2022
1 parent 2074b1f commit 832dab2
Show file tree
Hide file tree
Showing 8 changed files with 631 additions and 292 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "coprosize"
version = "1.0.0-alpha.7"
version = "1.0.0-alpha.8"
authors = ["Piotr Bajdek <piotr.bajdek@proton.me>"]
edition = "2021"
description = "command line tools for coprolite research (paleontology and archaeology): estimate the producer's body mass based on coprolite diameter by the use of regression models"
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[coprosize](https://github.com/piotrbajdek/coprosize) employs power, exponential and cubic regression models allowing to estimate the producer's body mass based on coprolite diameter. Models can be chosen accordingly to the supposed producer's taxon (at this stage of program development, only tetrapod models are implemented) and its diet type (carnivorous, herbivorous, omnivorous, unspecified). Implemented regression formulae are provided in [Supplement 1. Regression models](https://github.com/piotrbajdek/coprosize/blob/main/docs/supplement-1.ods) and constructed based on the data given in [Supplement 2. Scat diameters and body masses](https://github.com/piotrbajdek/coprosize/blob/main/docs/supplement-2.ods).

As it is aimed for science, [coprosize](https://github.com/piotrbajdek/coprosize) is written in Rust. The reasons for this choice are (1) the high code correctness guaranteed by Rust, (2) to ensure that each program version will be hosted 'for perpetuity' in the [registry](https://docs.rs/crate/coprosize/latest) and (3) that each program version will remain easily installed and cross-platform 'for perpetuity', thanks to the Rust's strict policy of backwards compatibility.
As it is aimed for science, [coprosize](https://github.com/piotrbajdek/coprosize) is written in Rust. The reasons for this choice are (1) the high code correctness guaranteed by Rust, (2) to ensure that each program version will be accessible in the [registry](https://docs.rs/crate/coprosize/latest) 'in perpetuity' and (3) that each program version will remain easily installed and cross-platform 'in perpetuity', thanks to the Rust's strict policy of backwards compatibility.

**As of v1.0.0-alpha.7, coprosize remains in an unstable fast-development phase. This program version is not intended for scientific research but for presentation of the technology and testing!**
**As of v1.0.0-alpha.8, coprosize remains in an unstable fast-development phase. This program version is not intended for scientific research but for presentation of the technology and testing!**

# USAGE

Expand All @@ -24,7 +24,7 @@ As it is aimed for science, [coprosize](https://github.com/piotrbajdek/coprosize

Please, always refer to a specific program version--implemented formulae are subject to change if new data are available (or simply studied by the author) or bugs of any kind are detected. Although coprosize is designed with the needs of a user in mind, you are perfectly OK to use my models in your study without really installing it as long as you cite this computer program as the original source. You are also OK to modify and fork coprosize under terms of the [MIT license](https://github.com/piotrbajdek/coprosize/blob/main/LICENSE).

Bajdek, P., 2022. coprosize (version 1.0.0-alpha.7). [computer software] https://github.com/piotrbajdek/coprosize
Bajdek, P., 2022. coprosize (version 1.0.0-alpha.8). [computer software] https://github.com/piotrbajdek/coprosize

# INSTALLATION ON LINUX

Expand All @@ -34,7 +34,7 @@ Bajdek, P., 2022. coprosize (version 1.0.0-alpha.7). [computer software] https:/

**1.** Install from crates.io by the use of cargo:

_cargo install coprosize \--version 1.0.0-alpha.7_
_cargo install coprosize \--version 1.0.0-alpha.8_

By default, the file will be downloaded to .cargo/bin/, a hidden folder in your home directory.

Expand All @@ -46,7 +46,7 @@ By default, the file will be downloaded to .cargo/bin/, a hidden folder in your

**1.** Download the binary 'coprosize' for Linux x86_64 from GitHub:

https://github.com/piotrbajdek/coprosize/releases/tag/v1.0.0-alpha.7
https://github.com/piotrbajdek/coprosize/releases/tag/v1.0.0-alpha.8

**2.** Make the file executable:

Expand All @@ -64,7 +64,7 @@ _sudo cp coprosize /var/usrlocal/bin/_

Download the coprosize source from GitHub. Then, build and install the program:

https://github.com/piotrbajdek/coprosize/releases/tag/v1.0.0-alpha.7
https://github.com/piotrbajdek/coprosize/releases/tag/v1.0.0-alpha.8

_cargo build \--release && sudo cp target/release/coprosize /usr/bin/_

Expand Down
Binary file modified docs/images/example-image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/help-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/supplement-1.ods
Binary file not shown.
Binary file modified docs/supplement-2.ods
Binary file not shown.
410 changes: 410 additions & 0 deletions src/lib.rs

Large diffs are not rendered by default.

499 changes: 214 additions & 285 deletions src/main.rs

Large diffs are not rendered by default.

0 comments on commit 832dab2

Please sign in to comment.