Skip to content

Commit

Permalink
Troubleshooting in README
Browse files Browse the repository at this point in the history
  • Loading branch information
tbennun committed Feb 15, 2022
1 parent 2551000 commit 0721582
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Quick Start

Install DaCe with pip: `pip install dace`

Having issues? See [Troubleshooting](#Troubleshooting)

Using DaCe in Python is as simple as adding a `@dace` decorator:
```python
import dace
Expand Down Expand Up @@ -116,14 +118,25 @@ If you use DaCe, cite us:
}
```

Troubleshooting
---------------

* If you are running on Mac OS and getting compilation errors when calling DaCe programs, make sure you have OpenMP installed and configured with Apple Clang. Otherwise, you can use GCC to compile the code by following these steps:
* Run `brew install gcc`
* Set your `~/.dace.conf` compiler configuration to use the installed GCC. For example, if you installed version 9 (`brew install gcc@9`), run `which g++-9` and set the config entry called `compiler.cpu.executable` (empty string by default) to the resulting path
* Remove any `.dacecache` folders to clear the cache

Other issues? Look for similar issues or start a discussion on our [GitHub Discussions](https://github.com/spcl/dace/discussions)!


Configuration
-------------

DaCe creates a file called `.dace.conf` in the user's home directory. It provides useful settings that can be modified either directly in the file (YAML), within DIODE, or overriden on a case-by-case basis using environment variables that begin with `DACE_` and specify the setting (where categories are separated by underscores). The full configuration schema is located [here](dace/config_schema.yml).

Useful environment variable configurations include:

* `DACE_CONFIG` (default: `~/.dace.conf`): Override DaCe configuration file choice.
* `DACE_CONFIG` (default: `~/.dace.conf`): Override DaCe configuration file choice.

General configuration:
* `DACE_debugprint` (default: False): Print debugging information.
Expand Down

0 comments on commit 0721582

Please sign in to comment.