Skip to content

Commit 7041eb9

Browse files
committed
modified documentation to mention rules branch
1 parent 9e9a092 commit 7041eb9

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/manual/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Below there are detailed info on how to contribute to the translation of new rul
2121

2222
# Contributing to translating new rules for RuleBasedMethod
2323

24-
In this repo there is also some software that serves the sole purpose of helping with the translation of rules from Mathematica syntax, and not for the actual package working. The important ones are:
25-
- translator_of_rules.jl is a script that with regex and other string manipulations translates from Mathematica syntax to julia syntax
24+
In the github repo of the package there is also some software that serves the sole purpose of helping with the translation of rules from Mathematica syntax, and not for the actual package working. The important ones are:
25+
- translator_of_rules.jl is a script that with regex and other string manipulations translates from Mathematica syntax to julia syntax (see "houw to use it" section later)
2626
- translator_of_testset.jl is a script that translates the testsets into julia syntax (much simpler than translator_of_rules.jl)
2727
- `reload_rules` function in rules_loader.jl. When developing the package using Revise is not enough because rules are defined with a macro. So this function reloads rules from a specific .jl file or from all files if called without arguments.
2828

@@ -81,7 +81,7 @@ This script is used to translate integration rules from Mathematica syntax
8181
to julia Syntax.
8282

8383
### How to use it
84-
It's handy to have the Mathematica files already in the correct folders in this repo (.m files are ignored by .gitignore), so that you can use the translator script like this:
84+
In the branch `rules` of the github repo of the package there are all the Mathematica files containing the untranslated rules already in the correct folders in this repo, so that you can use the translator script like this:
8585
``` bash
8686
julia src/translator_of_rules.jl "src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.m"
8787
```
@@ -177,4 +177,4 @@ finally the rule is placed in a tuple (index, rule), and all the
177177
tuples are put into a array, ready to be included by load_rules
178178

179179
## Adding Testsuites
180-
There is a test suite of 27585 solved integrals taken from the RUBI package, in the folders `test/test_files/0 Independent test suites` (1796 tests) and `test/test_files/1 Algebraic functions` (25798 tests). But more test can be translated from the [RUBI testsuite](https://rulebasedintegration.org/testProblems.html). In [this](https://github.com/Bumblebee00/SymbolicIntegration.jl?tab=readme-ov-file#testing) repo there are the tests still in Mathematica syntax and a script to translate them to julia.
180+
There is a test suite of 27585 solved integrals taken from the RUBI package, in the folders `test/test_files/0 Independent test suites` (1796 tests) and `test/test_files/1 Algebraic functions` (25798 tests). But more test can be translated from the [RUBI testsuite](https://rulebasedintegration.org/testProblems.html). In the branch `rules` of this repo there are the tests still in Mathematica syntax and a script to translate them to julia.

0 commit comments

Comments
 (0)