├── img ├── WDM_PSD.png ├── IFTS_logo.png ├── Constellation_After_CPE.png ├── Constellation_After_LC_GAN.png └── Constellation_After_LC_SSFM.png ├── README.md └── LICENSE /img/WDM_PSD.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FiberTransOfLIFE/IFTS/HEAD/img/WDM_PSD.png -------------------------------------------------------------------------------- /img/IFTS_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FiberTransOfLIFE/IFTS/HEAD/img/IFTS_logo.png -------------------------------------------------------------------------------- /img/Constellation_After_CPE.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FiberTransOfLIFE/IFTS/HEAD/img/Constellation_After_CPE.png -------------------------------------------------------------------------------- /img/Constellation_After_LC_GAN.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FiberTransOfLIFE/IFTS/HEAD/img/Constellation_After_LC_GAN.png -------------------------------------------------------------------------------- /img/Constellation_After_LC_SSFM.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/FiberTransOfLIFE/IFTS/HEAD/img/Constellation_After_LC_SSFM.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 | 5 | ------- 6 | # 简介 7 | 8 | IFTS是基于Python开发的智能光通信开源仿真工具,旨在满足科学家,光通信工程师及相关领域研究人员对于光通信仿真工具包的需求。与传统通信仿真工具不同的是,IFTS提供了基于Pytorch的仿真版本,并集成多种神经网络算法,这使得仿真平台可借助GPU和神经网络对仿真进行加速,天然兼容光通信的智能化算法设计。 9 | 10 | ### 注:当前阶段您还无法从GitHub中直接获取IFTS源代码,当前GitHub仅为我们提供了一个平台进行交流。如果您想使用与下载IFTS,您可以访问我们的 **[IFTS发布网站](https://ifibertrans.sjtu.edu.cn/)** ,从网站中获取IFTS。 11 | 12 | 13 | # 特点 14 | 15 | * 基于Python开发。易于上手,可根据自身需求扩展其功能。 16 | * 提供高效仿真。GPU并行计算与AI信道模型,加速智能仿真平台。 17 | * 开源免费。IFTS作为开源通信工具包,致力于助力光通信智能化研究。 18 | * 使用智能算法。聚焦光通信领域前沿,融合AI框架。 19 | 20 | # 可用功能 21 | 22 | IFTS提供了对完整光通信系统的传输仿真,内部可分为信道、发射端、接收端、信号和工具包等模块,是一款全面高效的光通信仿真工具包。以下为IFTS提供的模块的简要介绍,具体内容请用户参阅IFTS发布网站中的 **[用户手册说明](https://ifibertrans.sjtu.edu.cn/manual/)**。 23 | 24 | ### 信号模块 25 | 26 | 信号模块包含了与信号相关的操作,例如信号序列的生成、信号的调制与解调、信号相关的性能计算等,实现了仿真平台对信号部分的仿真,为其他模块提供了基础。 27 | 28 | ### 信道模块 29 | 30 | 信道模块用于构建仿真信道环境,支持光纤信道以及AWGN信道传输。其中光纤信道仿真可进一步分为仿真信道器件模块以及仿真信道传输模块,实现的功能按照信号处理流程依次为:波分复用、信道传输、解复用和相干接收。本平台支持的仿真光纤传输方法包括分布式傅里叶算法(split-step fourier method,SSFM)以及AI信道模型方法。 31 | 32 | ### 发射机模块 33 | 34 | 发射机模块实现对发射端的仿真,主要涉及到信号的脉冲整形。 35 | 36 | ### 接收机模块 37 | 38 | 接收机模块实现对接收端的仿真,主要内容包括接收端的多种DSP算法,如载波相位估计、自适应滤波、色散补偿、IQ平衡等算法。 39 | 40 | ### 工具包模块 41 | 42 | 工具包模块包含了代码中需要使用的各种功能性函数,例如进制转换、重采样、滤波器设计、滑动平均、数值计算等,为仿真提供了基础性的帮助。 43 | 44 | # 结果展示 45 | 46 | IFTS提供了对完整传输过程的仿真,并可以通过画图实现其中结果的可视化。下面对部分结果进行了展示,更多内容请用户参阅IFTS发布网站中使用说明的 **[代码运行](https://ifibertrans.sjtu.edu.cn/use.html)** 内容。 47 | 48 | ### 波分复用 49 | 50 | IFTS支持在信道中传输波分复用信号,如图1为三通道的信号功率谱密度示意图。 51 | 52 |
53 | 54 |
55 | 56 | 图1.波分复用信号功率谱密度图 57 |
58 | 59 | ### 光纤信道 60 | 61 | 当前版本的智能光传输仿真平台中,除了利用分布式傅里叶算法(SSFM)实现传输时光纤信道的仿真以外,IFTS还提供了利用生成式对抗网络(GAN, Generative Adversarial Networks)对光纤信道进行建模的NN信道仿真。NN信道仿真在保证准确率的同时能够实现光纤信道仿真的加速。如图2和图3分别为单通道,80km,入纤功率10.0dBm的条件下,采用SSFM与AI信道模型与进行传输仿真得到的收端经色散补偿后的信号星座图。 62 | 63 |
64 | 65 |
66 | 67 | 图2.分步傅里叶方法仿真传输信号收端色散补偿星座图 68 |
69 | 70 |
71 | 72 |
73 | 74 | 图3.GAN模型传输信号收端色散补偿星座图 75 |
76 | 77 | 78 | ### 信号恢复 79 | 80 | 发射端发送的光信号在经过光纤信道传输后不仅存在幅度的衰减,还存在由于光纤线性与非线性导致的信号畸变。仿真平台接收端采取一系列DSP算法,包括低通滤波,IQ平衡,色散补偿,自适应滤波,同步,载波相位估计等模块进行修正补偿,完成接收端信息恢复。如图4为收端DSP处理后的复原信号星座图。 81 | 82 |
83 | 84 |
85 | 86 | 图4.收端DSP处理后的复原信号星座图 87 |
88 | 89 | # 常见问题 90 | 91 | ## 如何下载和使用IFTS 92 | 93 | 当前阶段我们未将IFTS上传至GitHub中,所以您目前暂时无法从GitHub中直接下载与使用IFTS。您可以访问我们的 **[IFTS发布网站](https://ifibertrans.sjtu.edu.cn/)** ,登录网站后下载与使用IFTS,并参阅相关文档。 94 | 95 | ## GitHub平台的作用 96 | 97 | 虽然当前您无法直接从GitHub上获取IFTS,但是GitHub为我们提供了一个平台进行交流。您可以将您在IFTS基础上修改的代码或新增的测试通过GitHub issue进行提交;或将您遇到的Bug通过GitHub进行描述与反馈。我们将非常感谢您对IFTS的贡献。当然,我们更乐意您能够通过IFTS发布网站的[社区](https://ifibertrans.sjtu.edu.cn/community.html)与我们进行沟通与交流。 98 | 99 | ## 如何引用IFTS 100 | 101 | 如果您使用我们的智能光传输仿真平台后认为IFTS对您的的研究工作有所帮助,并且将IFTS用于出版物、报告或demo演示等,我们将非常感谢您的引用。我们提供了两种引用格式如下所示: 102 | 103 | #### MLA格式 104 | 105 | --- 106 | Zekun Niu, Hang Yang, Lyu Li, Minghui Shi, Chuyan Zeng, Chenhao Dai, Guozhi Xu, Haochen Zhao, 107 | and Lilin Yi. “Intelligent Fiber Transmission Simulation.” Intelligent Fiber Transmission 108 | Simulation Platform of Shanghai Jiao Tong University, LIFE, 2022, ifibertrans.sjtu.edu.cn/. 109 | 110 | --- 111 | 112 | #### BibTeX格式 113 | 114 | --- 115 | @misc{IFTSv0.1, 116 | author = {Zekun Niu and Hang Yang and Lyu Li and Minghui Shi and Chuyan Zeng and Chenhao 117 | Dai and Guozhi Xu and Haochen Zhao and Lilin Yi},
118 | title = {Intelligent Fiber Transmission Simulation},
119 | howpublished = {Available at \url{ifibertrans.sjtu.edu.cn}},
120 | year = 2022 121 | } 122 | 123 | --- 124 | 125 | ## 使用许可 126 | 127 | IFTS使用GNU通用公共许可证(GNU General Public License)。用户选择下载并使用本项目,即视为用户同意并遵循该协议。详细请见[LICENSE](https://ifibertrans.sjtu.edu.cn/use.html) 128 | 129 |
130 | 总而言之,我们希望借助IFTS提供算法验证平台,降低光通信智能化研究的门槛,打通信息壁垒。我们欢迎相关领域的专家下载、使用和改进IFTS,共同推动光通信的智能化发展。 131 | 132 |
133 | 134 |

By 智能光纤系统实验室LIFE智能光通信团队      

135 | 136 |

上海交通大学区域光纤通信网与新型光通信系统国家重点实验室

137 | 138 | 139 | 140 | ------- 141 | # Introduction 142 | 143 | IFTS is an open source simulation tool for intelligent optical communication based on Python, which aims to meet the needs of scientists, optical communication engineers and researchers in related fields for optical communication simulation toolkits.Different from the traditional communication simulation tools, IFTS provides a simulation version based on Pytorch, and integrates a variety of neural network algorithms, which makes the simulation platform can accelerate the simulation with the help of GPU and neural network, naturally compatible with the intelligent algorithm design of optical communication. 144 | 145 | ### Note: At present, you cannot directly obtain IFTS and its code from GitHub. Now, GitHub only provides us with a platform for communication. If you want to use and download IFTS, you can visit our **[IFTS publishing website](https://ifibertrans.sjtu.edu.cn/)** to obtain IFTS. 146 | 147 | # Characteristic 148 | 149 | * Python based development. It's easy to use, and can be expanded based on user's own needs. 150 | * Provide efficient simulation. GPU parallel computing and AI channel model is used to accelerate intelligent simulation platform. 151 | * Open source and free. As an open source communication toolkit, IFTS is committed to assisting the intelligent research of optical communication. 152 | * Use intelligence algorithms. Focus on the forefront of optical communication, and integrate AI framework. 153 | 154 | # Available Features 155 | 156 | IFTS provides transmission simulation for complete optical communication system, which can be divided into modules such as channel, transmitter, receiver, signal and tool box. It is a comprehensive and efficient optical communication simulation kit. The following is a brief description of the modules provided by IFTS. For details, please refer to the **[user manual](https://ifibertrans.sjtu.edu.cn/manual/)** on the IFTS publication website 。 157 | 158 | ### Signal Module 159 | 160 | The signal module includes the operations related to the signal, such as the generation of signal sequence, signal modulation and demodulation, signal related performance calculation, etc., which realizes the simulation of the signal part of the simulation platform and provides the foundation for other modules. 161 | 162 | ### Channel Module 163 | 164 | The channel module is used to build the simulation channel environment and support fiber channel and AWGN channel transmission. The fiber channel simulation can be further divided into the simulation channel device module and the simulation channel transmission module. The functions realized according to the signal processing process are wavelength division multiplexing, channel transmission, demultiplexing and coherent receiving. The simulation optical fiber transmission methods supported by the platform include the distributed split-step fourier method (SSFM) and AI channel model method. 165 | 166 | ### Tx Module 167 | 168 | The Tx module realizes the simulation of the transmitter, which mainly involves the pulse shaping of the signal. 169 | 170 | ### Rx Module 171 | 172 | The Rx module realizes the simulation of the receiver, which mainly includes a variety of DSP algorithms on the receiving end, such as carrier phase estimation, adaptive filtering, dispersion compensation, IQ balance and other algorithms. 173 | 174 | ### ToolBox Module 175 | 176 | The toolbox module contains various functional functions that need to be used in the code, such as base conversion, resampling, filter design, sliding average, numerical calculation, etc., which provides basic help for simulation. 177 | 178 | # Results Presentation 179 | 180 | IFTS provides a simulation of the complete transmission process, and the results can be visualized by figure. Some of the results are shown below. For more information, please refer to the **[code running instructions](https://ifibertrans.sjtu.edu.cn/use.html)** on the IFTS distribution website. 181 | 182 | ### WDM 183 | 184 | IFTS supports the transmission of WDM signals in the channel. Figure 1 shows the schematic diagram of signal power spectral density of three-channel. 185 | 186 |
187 | 188 |
189 | 190 | Fig 1.Power spectral density diagram of WDM signal 191 |
192 | 193 | ### Fiber Channel 194 | 195 | In the current version of IFTS, in addition to using SSFM algorithm to realize the simulation of optical fiber channel during transmission, IFTS also provides NN channel simulation to model fiber optic channels using Generative Adversarial Networks (GAN). NN channel simulation can realize the acceleration of fiber channel simulation while ensuring the accuracy. In Figure 2 and Figure 3, the signal constellation of the receiver after dispersion compensation is obtained by using SSFM and AI channel model and transmission simulation under the condition of single channel, 80km and 10.0dBm power, respectively. 196 | 197 |
198 | 199 |
200 | 201 | Fig 2.Dispersion compensation constellation of SSFM model 202 |
203 | 204 |
205 | 206 |
207 | 208 | Fig 3.Dispersion compensation constellation of GAN model 209 |
210 | 211 | 212 | ### Signal Recovery 213 | 214 | The optical signal sent by the transmitter not only has amplitude attenuation after transmission through the fiber channel, but also has the signal distortion caused by the linear and nonlinear affection. The receiver of the simulation platform adopts a series of DSP algorithms, including low-pass filtering, IQ balance, dispersion compensation, adaptive filtering, synchronization, carrier phase estimation and other modules to correct compensation and complete the information recovery at the receiver. Figure 4 shows the constellation diagram of restored signal after receiver DSP. 215 | 216 |
217 | 218 |
219 | 220 | Fig 4.Constellation of recovered signal after receiver DSP 221 |
222 | 223 | # FAQs 224 | 225 | ## How to install and use IFTS 226 | 227 | At the current stage, we have not uploaded IFTS to GitHub, so you cannot directly install and use IFTS from GitHub. You can visit our **[IFTS publishing website](https://ifibertrans.sjtu.edu.cn/)**, log in to the website, install and use IFTS, and refer to relevant documents. 228 | 229 | ## The role of GitHub 230 | 231 | Although you cannot directly obtain IFTS from GitHub, GitHub provides us with a platform for communication. You can submit your modified code or new test based on IFTS through GitHub issue; Or describe and feed back the bugs you encounter through GitHub. Of course, we would like you to communicate with us through the [community](https://ifibertrans.sjtu.edu.cn/community.html) of IFTS publishing website. 232 | 233 | ## How to reference IFTS 234 | 235 | If you use our transmission simulation platform and think that IFTS is helpful to your research work, or you use IFTS for for a publication, presentation or a demo, we will appreciate your reference. We provide two reference formats as follows: 236 | 237 | #### MLA format 238 | 239 | --- 240 | Zekun Niu, Hang Yang, Lyu Li, Minghui Shi, Chuyan Zeng, Chenhao Dai, Guozhi Xu, Haochen Zhao, 241 | and Lilin Yi. “Intelligent Fiber Transmission Simulation.” Intelligent Fiber Transmission 242 | Simulation Platform of Shanghai Jiao Tong University, LIFE, 2022, ifibertrans.sjtu.edu.cn/. 243 | 244 | --- 245 | 246 | #### BibTeX format 247 | 248 | --- 249 | @misc{IFTSv0.1, 250 | author = {Zekun Niu and Hang Yang and Lyu Li and Minghui Shi and Chuyan Zeng and Chenhao 251 | Dai and Guozhi Xu and Haochen Zhao and Lilin Yi},
252 | title = {Intelligent Fiber Transmission Simulation},
253 | howpublished = {Available at \url{ifibertrans.sjtu.edu.cn}},
254 | year = 2022 255 | } 256 | 257 | --- 258 | 259 | ## Use License 260 | 261 | IFTS uses the GNU General Public License. If the user chooses to install and use our project, it is deemed that the user agrees and follows this agreement. See [LICENSE](https://ifibertrans.sjtu.edu.cn/use.html) for details. 262 | 263 |
264 | 265 | In a word, we hope to provide an algorithm verification platform with the help of IFTS, reduce the threshold of intelligent optical communication research, and break through the information barriers. Experts in related fields are welcome to download, use and improve IFTS, so as to jointly promote the intelligent development of optical communication. 266 |
267 | 268 |

By Intelligent optical communication team of LIFE          

269 | 270 |

State Key Laboratory of Advanced Optical Communication Systems and Networks

271 | 272 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------