summaryrefslogtreecommitdiff
path: root/python-tweedledum-dev.spec
blob: 0066192b0153b0cae46f574edaaacc0bbcbe0f47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
%global _empty_manifest_terminate_build 0
Name:		python-tweedledum-dev
Version:	1.2.0.dev202111120116
Release:	1
Summary:	A library for synthesizing and manipulating quantum circuits
License:	MIT
URL:		https://github.com/boschmitt/tweedledum
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/f6/97/047edfdf807e907c09f64ea5f0c67b423830331d5825e6b2a9f4a2d70890/tweedledum-dev-1.2.0.dev202111120116.tar.gz


%description
<p align="center">
  <img src="https://cdn.rawgit.com/boschmitt/tweedledum/master/tweedledum.svg" width="128" height="128" style="margin-right: 12pt"/>
</p>
<p align="center">
  <img src="https://img.shields.io/badge/license-MIT-000000.svg">
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/macos.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/MacOS/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/ubuntu.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Ubuntu/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/windows.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Windows/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml.yml">
    <img src="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml/badge.svg">
  </a>
</p>

    /!\ (Warning) If you have used tweedledum before: the master branch history is broken.
    /!\ The new master branch is a completely rewrite of the library. The old version can be found
    /!\ on **alpha** branch. (Sorry for the inconvenience!!---but it is for a great cause)

**tweedledum** is a library for synthesis, compilation, and optimization of
quantum circuits.  The library is written to be scalable up to problem sizes in
which quantum circuits outperform classical ones. Also, it is meant to be used
both independently and alongside established tools.


Its design is guided by three mantras:

- __Gotta run fast__: execution-time performance is a priority.

- __Your compiler, your rules__.  You know better. At least, Tweedledum 
hopes so! The library provides a standard set of operators that can be easily 
extended (thanks to some type-erasure black magic).  However, the library will 
leave your operators completely alone if you don't write passes that 
specifically manipulate them.  Furthermore, Tweedledum will rarely take any
decision in your behalf, i.e., it does not provide generic methods to optimize
or synthesize circuits, you need to specifically call the algorithms you want.

- __Opinionated, but not stubborn__.  Many passes and synthesis algorithms have
many configuration parameters.  Tweedledum comes with reasonable defaults and 
curated opinions of what value such parameters should take.  But in the end,
it all up to you.

__Corollary__:  Because of it's flexibility, Tweedledum is capable of accepting
gates/operators that are defined as python classes.  Indeed, any pythonic 
framework can use the library as a circuit manager.  Meaning that the library 
can be used to slowly transition the core and performance sensitive parts of a 
pythonic framework to C++, while maintaining the capability of users to develop
passes in python.

# Installation

[Known issues](#known-issues) with _macOS High Sierra (10.13)_ and _macOS Mojave (10.14)_.

`tweedledum` has two python packages that can be installed using `pip`.  For
both, you will at least __Python 3.6__.  The `tweedledum` package contains the
latest stable release.  You can install it from PyPI using:

* Latest stable release (Linux/Mac/Windows)

```
pip install tweedledum
```

For the developers, users or researchers who are comfortable living on the 
absolute bleeding edge, `tweedledum-dev` contains that latest developments 
merged into the master branch.

* Latest (Linux/Mac/Windows)

```
pip install tweedledum-dev
```

__Warning__: The two packages cannot be installed together.

# Installation from source (Development)

Installing `tweedledum` from the source, instead of using the Python Package 
Index (PyPI) repository version, allows you to extend the latest version of the
code. In the following, I will explain two workflows I personally use for
development. Choose one that best suits your needs.

Alright, both workflows start the same way. You clone the repository:
```
git clone https://github.com/boschmitt/tweedledum.git
```

## C++
The first workflow is pure C++. We start by creating a directory to hold the 
build output:

```
mkdir build      
cd build
```

Note that the library has a directory named `examples/`.  If we set the
``TWEEDLEDUM_EXAMPLES`` CMake variable to ``TRUE``.  Any `.cpp` file in this
directory will be compiled to its own executable. 

So, lets assume you have a file named `hello_world.cpp` in the `examples/`.
First we configure our project and enable the examples:

```
cmake -DTWEEDLEDUM_EXAMPLES=TRUE ..
```

If you are on a \*nix system, you should now see a Makefile in the current
directory. Now you can build the library by running `make`. At this point you
can build the `hello_world` executable by calling

```
make hello_world
```

Once the examples have been built you can run it:

```
./examples/hello_world
```

## C++ and Python

The second workflow is a bit of a hack.  In Python we can install libraries in
editable mode, meaning that code changes to the _Python code_ in the project
don't require a reinstall to be applied. 

If you want to install it in editable mode, you can do this with:
```
pip install -e .
```

The only problem now, is that if we change the C++ code, we will need to 
reinstall the library.  Fortunately, there is a way to circumvent this 
annoyance.  

After installing in editable mode, you will see that in `python/tweedledum/` 
there is a cpython shared library `_tweedledum.cpython-...` Remove this file:

```sh
rm python/tweedledum/_tweedledum.cpython-...
```

Now, we create a build directory as we did with the C++ workflow:
```sh
mkdir build      
cd build
```

We can manually build the cpython shared library using:
```sh
make _tweedledum
```

This will create the library in the `build/` directory. Now, all we need to
create a symbolic link in `python/tweedledum/` that points the library in 
`build/`:

```sh
ln -s _tweedledum.cpython-39-darwin.so ../python/tweedledum/
```

Now, whenever we change the C++ code and rebuild the python library, the changes
won't require a reinstall of the library to be available.

# Used third-party tools

The library it is built, tested, bind to python, and whatnot using many
third-party tools and services. Thanks a lot!

- [**abc**](https://github.com/berkeley-abc/abc) - ABC: System for Sequential Logic Synthesis and Formal Verification
- [**bill**](https://github.com/lsils/bill) - C++ header-only reasoning library
- [**Catch2**](https://github.com/catchorg/Catch2) test framework for unit-tests, TDD and BDD
- [**CMake**](https://cmake.org) for build automation
- [**Eigen**](https://gitlab.com/libeigen/eigen) template library for linear algebra
- [**{fmt}**](https://github.com/fmtlib/fmt) - A modern formatting library
- [**kitty**](https://github.com/msoeken/kitty) - truth table library 
- [**lorina**](https://github.com/hriener/lorina) - C++ parsing library for simple formats used in logic synthesis and formal verification 
- [**mockturtle**](https://github.com/lsils/mockturtle) - C++ logic network library
- [**nlohmann/json**](https://github.com/nlohmann/json) - JSON for Modern C++
- [**parallel_hashmap**](https://github.com/greg7mdp/parallel-hashmap) - A family of header-only, very fast and memory-friendly hashmap and btree containers.
- [**percy**](https://github.com/lsils/percy) - C++ header-only exact synthesis library
- [**pybind11**](https://github.com/pybind/pybind11) - Seamless operability between C++11 and Python
- [**rang**](https://github.com/agauniyal/rang) - A Minimal, Header only Modern c++ library for terminal goodies

## Known issues

These are issues that hopefully will be fixed, but currently are unsolved.  If
you know how to help with one of these issues, contributions are welcome!

### macOS: High Sierra (10.13) and Mojave (10.14)

`tweedledum` offers limited support for both systems.  While wheels might be
available for some releases, it is strongly advised to install `tweedledum` or
`tweedledum-dev` by building them directly from source.  For example:

```sh
CC=gcc-10 CXX=g++-10 CXXFLAGS="-static-libgcc -static-libstdc++" pip install tweedledum --no-binary :all:
```

Note that such command requires a working `gcc10` installation. (It also works
with `gcc11`, but no further tests were made.) I recommend the use of 
[Homebrew](https://brew.sh) to install `gcc`. (Or maybe 
[Tigerbrew](https://github.com/mistydemeo/tigerbrew))

## License

This software is licensed under the MIT licence (see 
[LICENSE](https://github.com/boschmitt/tweedledum/blob/master/LICENSE)).

## EPFL logic synthesis libraries

tweedledum is part of the
[EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.
The other libraries and several examples on how to use and integrate the 
libraries can be found in the 
[logic synthesis tool showcase](https://github.com/lsils/lstools-showcase).




%package -n python3-tweedledum-dev
Summary:	A library for synthesizing and manipulating quantum circuits
Provides:	python-tweedledum-dev
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
BuildRequires:	python3-cffi
BuildRequires:	gcc
BuildRequires:	gdb
%description -n python3-tweedledum-dev
<p align="center">
  <img src="https://cdn.rawgit.com/boschmitt/tweedledum/master/tweedledum.svg" width="128" height="128" style="margin-right: 12pt"/>
</p>
<p align="center">
  <img src="https://img.shields.io/badge/license-MIT-000000.svg">
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/macos.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/MacOS/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/ubuntu.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Ubuntu/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/windows.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Windows/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml.yml">
    <img src="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml/badge.svg">
  </a>
</p>

    /!\ (Warning) If you have used tweedledum before: the master branch history is broken.
    /!\ The new master branch is a completely rewrite of the library. The old version can be found
    /!\ on **alpha** branch. (Sorry for the inconvenience!!---but it is for a great cause)

**tweedledum** is a library for synthesis, compilation, and optimization of
quantum circuits.  The library is written to be scalable up to problem sizes in
which quantum circuits outperform classical ones. Also, it is meant to be used
both independently and alongside established tools.


Its design is guided by three mantras:

- __Gotta run fast__: execution-time performance is a priority.

- __Your compiler, your rules__.  You know better. At least, Tweedledum 
hopes so! The library provides a standard set of operators that can be easily 
extended (thanks to some type-erasure black magic).  However, the library will 
leave your operators completely alone if you don't write passes that 
specifically manipulate them.  Furthermore, Tweedledum will rarely take any
decision in your behalf, i.e., it does not provide generic methods to optimize
or synthesize circuits, you need to specifically call the algorithms you want.

- __Opinionated, but not stubborn__.  Many passes and synthesis algorithms have
many configuration parameters.  Tweedledum comes with reasonable defaults and 
curated opinions of what value such parameters should take.  But in the end,
it all up to you.

__Corollary__:  Because of it's flexibility, Tweedledum is capable of accepting
gates/operators that are defined as python classes.  Indeed, any pythonic 
framework can use the library as a circuit manager.  Meaning that the library 
can be used to slowly transition the core and performance sensitive parts of a 
pythonic framework to C++, while maintaining the capability of users to develop
passes in python.

# Installation

[Known issues](#known-issues) with _macOS High Sierra (10.13)_ and _macOS Mojave (10.14)_.

`tweedledum` has two python packages that can be installed using `pip`.  For
both, you will at least __Python 3.6__.  The `tweedledum` package contains the
latest stable release.  You can install it from PyPI using:

* Latest stable release (Linux/Mac/Windows)

```
pip install tweedledum
```

For the developers, users or researchers who are comfortable living on the 
absolute bleeding edge, `tweedledum-dev` contains that latest developments 
merged into the master branch.

* Latest (Linux/Mac/Windows)

```
pip install tweedledum-dev
```

__Warning__: The two packages cannot be installed together.

# Installation from source (Development)

Installing `tweedledum` from the source, instead of using the Python Package 
Index (PyPI) repository version, allows you to extend the latest version of the
code. In the following, I will explain two workflows I personally use for
development. Choose one that best suits your needs.

Alright, both workflows start the same way. You clone the repository:
```
git clone https://github.com/boschmitt/tweedledum.git
```

## C++
The first workflow is pure C++. We start by creating a directory to hold the 
build output:

```
mkdir build      
cd build
```

Note that the library has a directory named `examples/`.  If we set the
``TWEEDLEDUM_EXAMPLES`` CMake variable to ``TRUE``.  Any `.cpp` file in this
directory will be compiled to its own executable. 

So, lets assume you have a file named `hello_world.cpp` in the `examples/`.
First we configure our project and enable the examples:

```
cmake -DTWEEDLEDUM_EXAMPLES=TRUE ..
```

If you are on a \*nix system, you should now see a Makefile in the current
directory. Now you can build the library by running `make`. At this point you
can build the `hello_world` executable by calling

```
make hello_world
```

Once the examples have been built you can run it:

```
./examples/hello_world
```

## C++ and Python

The second workflow is a bit of a hack.  In Python we can install libraries in
editable mode, meaning that code changes to the _Python code_ in the project
don't require a reinstall to be applied. 

If you want to install it in editable mode, you can do this with:
```
pip install -e .
```

The only problem now, is that if we change the C++ code, we will need to 
reinstall the library.  Fortunately, there is a way to circumvent this 
annoyance.  

After installing in editable mode, you will see that in `python/tweedledum/` 
there is a cpython shared library `_tweedledum.cpython-...` Remove this file:

```sh
rm python/tweedledum/_tweedledum.cpython-...
```

Now, we create a build directory as we did with the C++ workflow:
```sh
mkdir build      
cd build
```

We can manually build the cpython shared library using:
```sh
make _tweedledum
```

This will create the library in the `build/` directory. Now, all we need to
create a symbolic link in `python/tweedledum/` that points the library in 
`build/`:

```sh
ln -s _tweedledum.cpython-39-darwin.so ../python/tweedledum/
```

Now, whenever we change the C++ code and rebuild the python library, the changes
won't require a reinstall of the library to be available.

# Used third-party tools

The library it is built, tested, bind to python, and whatnot using many
third-party tools and services. Thanks a lot!

- [**abc**](https://github.com/berkeley-abc/abc) - ABC: System for Sequential Logic Synthesis and Formal Verification
- [**bill**](https://github.com/lsils/bill) - C++ header-only reasoning library
- [**Catch2**](https://github.com/catchorg/Catch2) test framework for unit-tests, TDD and BDD
- [**CMake**](https://cmake.org) for build automation
- [**Eigen**](https://gitlab.com/libeigen/eigen) template library for linear algebra
- [**{fmt}**](https://github.com/fmtlib/fmt) - A modern formatting library
- [**kitty**](https://github.com/msoeken/kitty) - truth table library 
- [**lorina**](https://github.com/hriener/lorina) - C++ parsing library for simple formats used in logic synthesis and formal verification 
- [**mockturtle**](https://github.com/lsils/mockturtle) - C++ logic network library
- [**nlohmann/json**](https://github.com/nlohmann/json) - JSON for Modern C++
- [**parallel_hashmap**](https://github.com/greg7mdp/parallel-hashmap) - A family of header-only, very fast and memory-friendly hashmap and btree containers.
- [**percy**](https://github.com/lsils/percy) - C++ header-only exact synthesis library
- [**pybind11**](https://github.com/pybind/pybind11) - Seamless operability between C++11 and Python
- [**rang**](https://github.com/agauniyal/rang) - A Minimal, Header only Modern c++ library for terminal goodies

## Known issues

These are issues that hopefully will be fixed, but currently are unsolved.  If
you know how to help with one of these issues, contributions are welcome!

### macOS: High Sierra (10.13) and Mojave (10.14)

`tweedledum` offers limited support for both systems.  While wheels might be
available for some releases, it is strongly advised to install `tweedledum` or
`tweedledum-dev` by building them directly from source.  For example:

```sh
CC=gcc-10 CXX=g++-10 CXXFLAGS="-static-libgcc -static-libstdc++" pip install tweedledum --no-binary :all:
```

Note that such command requires a working `gcc10` installation. (It also works
with `gcc11`, but no further tests were made.) I recommend the use of 
[Homebrew](https://brew.sh) to install `gcc`. (Or maybe 
[Tigerbrew](https://github.com/mistydemeo/tigerbrew))

## License

This software is licensed under the MIT licence (see 
[LICENSE](https://github.com/boschmitt/tweedledum/blob/master/LICENSE)).

## EPFL logic synthesis libraries

tweedledum is part of the
[EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.
The other libraries and several examples on how to use and integrate the 
libraries can be found in the 
[logic synthesis tool showcase](https://github.com/lsils/lstools-showcase).




%package help
Summary:	Development documents and examples for tweedledum-dev
Provides:	python3-tweedledum-dev-doc
%description help
<p align="center">
  <img src="https://cdn.rawgit.com/boschmitt/tweedledum/master/tweedledum.svg" width="128" height="128" style="margin-right: 12pt"/>
</p>
<p align="center">
  <img src="https://img.shields.io/badge/license-MIT-000000.svg">
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/macos.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/MacOS/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/ubuntu.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Ubuntu/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/windows.yml">
    <img src="https://github.com/boschmitt/tweedledum/workflows/Windows/badge.svg">
  </a>
  <a href="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml.yml">
    <img src="https://github.com/boschmitt/tweedledum/actions/workflows/build_wheels.yml/badge.svg">
  </a>
</p>

    /!\ (Warning) If you have used tweedledum before: the master branch history is broken.
    /!\ The new master branch is a completely rewrite of the library. The old version can be found
    /!\ on **alpha** branch. (Sorry for the inconvenience!!---but it is for a great cause)

**tweedledum** is a library for synthesis, compilation, and optimization of
quantum circuits.  The library is written to be scalable up to problem sizes in
which quantum circuits outperform classical ones. Also, it is meant to be used
both independently and alongside established tools.


Its design is guided by three mantras:

- __Gotta run fast__: execution-time performance is a priority.

- __Your compiler, your rules__.  You know better. At least, Tweedledum 
hopes so! The library provides a standard set of operators that can be easily 
extended (thanks to some type-erasure black magic).  However, the library will 
leave your operators completely alone if you don't write passes that 
specifically manipulate them.  Furthermore, Tweedledum will rarely take any
decision in your behalf, i.e., it does not provide generic methods to optimize
or synthesize circuits, you need to specifically call the algorithms you want.

- __Opinionated, but not stubborn__.  Many passes and synthesis algorithms have
many configuration parameters.  Tweedledum comes with reasonable defaults and 
curated opinions of what value such parameters should take.  But in the end,
it all up to you.

__Corollary__:  Because of it's flexibility, Tweedledum is capable of accepting
gates/operators that are defined as python classes.  Indeed, any pythonic 
framework can use the library as a circuit manager.  Meaning that the library 
can be used to slowly transition the core and performance sensitive parts of a 
pythonic framework to C++, while maintaining the capability of users to develop
passes in python.

# Installation

[Known issues](#known-issues) with _macOS High Sierra (10.13)_ and _macOS Mojave (10.14)_.

`tweedledum` has two python packages that can be installed using `pip`.  For
both, you will at least __Python 3.6__.  The `tweedledum` package contains the
latest stable release.  You can install it from PyPI using:

* Latest stable release (Linux/Mac/Windows)

```
pip install tweedledum
```

For the developers, users or researchers who are comfortable living on the 
absolute bleeding edge, `tweedledum-dev` contains that latest developments 
merged into the master branch.

* Latest (Linux/Mac/Windows)

```
pip install tweedledum-dev
```

__Warning__: The two packages cannot be installed together.

# Installation from source (Development)

Installing `tweedledum` from the source, instead of using the Python Package 
Index (PyPI) repository version, allows you to extend the latest version of the
code. In the following, I will explain two workflows I personally use for
development. Choose one that best suits your needs.

Alright, both workflows start the same way. You clone the repository:
```
git clone https://github.com/boschmitt/tweedledum.git
```

## C++
The first workflow is pure C++. We start by creating a directory to hold the 
build output:

```
mkdir build      
cd build
```

Note that the library has a directory named `examples/`.  If we set the
``TWEEDLEDUM_EXAMPLES`` CMake variable to ``TRUE``.  Any `.cpp` file in this
directory will be compiled to its own executable. 

So, lets assume you have a file named `hello_world.cpp` in the `examples/`.
First we configure our project and enable the examples:

```
cmake -DTWEEDLEDUM_EXAMPLES=TRUE ..
```

If you are on a \*nix system, you should now see a Makefile in the current
directory. Now you can build the library by running `make`. At this point you
can build the `hello_world` executable by calling

```
make hello_world
```

Once the examples have been built you can run it:

```
./examples/hello_world
```

## C++ and Python

The second workflow is a bit of a hack.  In Python we can install libraries in
editable mode, meaning that code changes to the _Python code_ in the project
don't require a reinstall to be applied. 

If you want to install it in editable mode, you can do this with:
```
pip install -e .
```

The only problem now, is that if we change the C++ code, we will need to 
reinstall the library.  Fortunately, there is a way to circumvent this 
annoyance.  

After installing in editable mode, you will see that in `python/tweedledum/` 
there is a cpython shared library `_tweedledum.cpython-...` Remove this file:

```sh
rm python/tweedledum/_tweedledum.cpython-...
```

Now, we create a build directory as we did with the C++ workflow:
```sh
mkdir build      
cd build
```

We can manually build the cpython shared library using:
```sh
make _tweedledum
```

This will create the library in the `build/` directory. Now, all we need to
create a symbolic link in `python/tweedledum/` that points the library in 
`build/`:

```sh
ln -s _tweedledum.cpython-39-darwin.so ../python/tweedledum/
```

Now, whenever we change the C++ code and rebuild the python library, the changes
won't require a reinstall of the library to be available.

# Used third-party tools

The library it is built, tested, bind to python, and whatnot using many
third-party tools and services. Thanks a lot!

- [**abc**](https://github.com/berkeley-abc/abc) - ABC: System for Sequential Logic Synthesis and Formal Verification
- [**bill**](https://github.com/lsils/bill) - C++ header-only reasoning library
- [**Catch2**](https://github.com/catchorg/Catch2) test framework for unit-tests, TDD and BDD
- [**CMake**](https://cmake.org) for build automation
- [**Eigen**](https://gitlab.com/libeigen/eigen) template library for linear algebra
- [**{fmt}**](https://github.com/fmtlib/fmt) - A modern formatting library
- [**kitty**](https://github.com/msoeken/kitty) - truth table library 
- [**lorina**](https://github.com/hriener/lorina) - C++ parsing library for simple formats used in logic synthesis and formal verification 
- [**mockturtle**](https://github.com/lsils/mockturtle) - C++ logic network library
- [**nlohmann/json**](https://github.com/nlohmann/json) - JSON for Modern C++
- [**parallel_hashmap**](https://github.com/greg7mdp/parallel-hashmap) - A family of header-only, very fast and memory-friendly hashmap and btree containers.
- [**percy**](https://github.com/lsils/percy) - C++ header-only exact synthesis library
- [**pybind11**](https://github.com/pybind/pybind11) - Seamless operability between C++11 and Python
- [**rang**](https://github.com/agauniyal/rang) - A Minimal, Header only Modern c++ library for terminal goodies

## Known issues

These are issues that hopefully will be fixed, but currently are unsolved.  If
you know how to help with one of these issues, contributions are welcome!

### macOS: High Sierra (10.13) and Mojave (10.14)

`tweedledum` offers limited support for both systems.  While wheels might be
available for some releases, it is strongly advised to install `tweedledum` or
`tweedledum-dev` by building them directly from source.  For example:

```sh
CC=gcc-10 CXX=g++-10 CXXFLAGS="-static-libgcc -static-libstdc++" pip install tweedledum --no-binary :all:
```

Note that such command requires a working `gcc10` installation. (It also works
with `gcc11`, but no further tests were made.) I recommend the use of 
[Homebrew](https://brew.sh) to install `gcc`. (Or maybe 
[Tigerbrew](https://github.com/mistydemeo/tigerbrew))

## License

This software is licensed under the MIT licence (see 
[LICENSE](https://github.com/boschmitt/tweedledum/blob/master/LICENSE)).

## EPFL logic synthesis libraries

tweedledum is part of the
[EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.
The other libraries and several examples on how to use and integrate the 
libraries can be found in the 
[logic synthesis tool showcase](https://github.com/lsils/lstools-showcase).




%prep
%autosetup -n tweedledum-dev-1.2.0.dev202111120116

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-tweedledum-dev -f filelist.lst
%dir %{python3_sitearch}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.0.dev202111120116-1
- Package Spec generated