You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/manual/contributing.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,10 @@
1
-
-[Contributing to improving RuleBasedMethod](#contributing-to-improving-rulebasedmethod)
1
+
# Contributing
2
+
3
+
We welcome contributions!
4
+
5
+
Below there are detailed info on how to contribute to the translation of new rules from the Mathematica rules of the RUBI package.
6
+
7
+
-[Contributing to RuleBasedMethod](#contributing-to-rulebasedmethod)
2
8
-[Common problems when translating rules](#common-problems-when-translating-rules)
3
9
-[function not translated](#function-not-translated)
4
10
-[Sum function translation](#sum-function-translation)
@@ -13,7 +19,7 @@
13
19
-[end](#end)
14
20
-[Adding Testsuites](#adding-testsuites)
15
21
16
-
# Contributing to improving RuleBasedMethod
22
+
# Contributing to translating new rules for RuleBasedMethod
17
23
18
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:
19
25
- translator_of_rules.jl is a script that with regex and other string manipulations translates from Mathematica syntax to julia syntax
@@ -75,10 +81,11 @@ This script is used to translate integration rules from Mathematica syntax
75
81
to julia Syntax.
76
82
77
83
### 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:
78
85
```bash
79
86
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"
80
87
```
81
-
and will produce the julia file at the path `src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.jl`
88
+
this will produce the julia file at the path `src/rules/4 Trig functions/4.1 Sine/4.1.8 trig^m (a+b cos^p+c sin^q)^n.jl`
82
89
83
90
### How it works internally (useful to know if you have to debug it)
84
91
It processes line per line, so the integration rule must be all on only one
0 commit comments